svapp.hxx

Go to the documentation of this file.

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */

#ifndef INCLUDED_VCL_SVAPP_HXX
#define INCLUDED_VCL_SVAPP_HXX

#include <sal/config.h>
#include <sal/types.h>

#include <cassert>
#include <vector>

#include <comphelper/solarmutex.hxx>
#include <LibreOfficeKit/LibreOfficeKitTypes.h>
#include <osl/mutex.hxx>
#include <rtl/ustring.hxx>
#include <osl/thread.h>
#include <tools/gen.hxx>
#include <tools/link.hxx>
#include <vcl/dllapi.h>
#include <vcl/IDialogRenderable.hxx>
#include <vcl/inputtypes.hxx>
#include <vcl/exceptiontypes.hxx>
#include <vcl/vclevent.hxx>
#include <vcl/vclenum.hxx>
#include <i18nlangtag/lang.h>
#include <o3tl/typed_flags_set.hxx>
#include <com/sun/star/uno/Reference.h>


class BitmapEx;
namespace weld
{
    class Builder;
    class MessageDialog;
    class Widget;
    class Window;
}
class LocaleDataWrapper;
class AllSettings;
class DataChangedEvent;
class Accelerator;
class Help;
class OutputDevice;
namespace vcl { class Window; }
namespace vcl { class KeyCode; }
class NotifyEvent;
class KeyEvent;
class MouseEvent;
class GestureEvent;
struct ImplSVEvent;
struct ConvertData;

namespace com::sun::star::uno {
    class XComponentContext;
}
namespace com::sun::star::ui::dialogs {
    class XFilePicker2;
    class XFolderPicker2;
}
namespace com::sun::star::awt {
    class XToolkit;
    class XDisplayConnection;
    class XWindow;
}

// helper needed by SalLayout implementations as well as svx/source/dialog/svxbmpnumbalueset.cxx
VCL_DLLPUBLIC sal_UCS4 GetMirroredChar( sal_UCS4 );
VCL_DLLPUBLIC sal_UCS4 GetLocalizedChar( sal_UCS4, LanguageType );

enum class SystemWindowFlags {
    NOAUTOMODE    = 0x0001,
    DIALOG        = 0x0002
};
namespace o3tl
{
    template<> struct typed_flags<SystemWindowFlags> : is_typed_flags<SystemWindowFlags, 0x03> {};
}

typedef long (*VCLEventHookProc)( NotifyEvent& rEvt, void* pData );

class VCL_DLLPUBLIC ApplicationEvent
{
public:
    enum class Type {
        Accept,                
        Appear,                
        Open,                  
        OpenHelpUrl,           
        Print,                 
        PrivateDoShutdown,    
        QuickStart,            
        ShowDialog,            
        Unaccept               
    };

    explicit ApplicationEvent(Type type): aEvent(type)
    {
        assert(type == Type::Appear || type == Type::PrivateDoShutdown || type == Type::QuickStart);
    }

    ApplicationEvent(Type type, OUString const & data): aEvent(type)
    {
        assert(
            type == Type::Accept || type == Type::OpenHelpUrl
            || type == Type::ShowDialog || type == Type::Unaccept);
        aData.push_back(data);
    }

    ApplicationEvent(Type type, std::vector<OUString>&& data):
        aEvent(type), aData(std::move(data))
    {
        assert(type == Type::Open || type == Type::Print);
    }

    Type GetEvent() const
    {
        return aEvent;
    }

    OUString const & GetStringData() const
    {
        assert(
            aEvent == Type::Accept
            || aEvent == Type::OpenHelpUrl || aEvent == Type::ShowDialog
            || aEvent == Type::Unaccept);
        assert(aData.size() == 1);
        return aData[0];
    }

    std::vector<OUString> const & GetStringsData() const
    {
        assert(aEvent == Type::Open || aEvent == Type::Print);
        return aData;
    }

private:
    Type aEvent;
    std::vector<OUString> aData;
};

enum class DialogCancelMode {
    Off,      
    Silent,   
    LOKSilent, 
    Fatal     
};

class VCL_DLLPUBLIC Application : public vcl::ILibreOfficeKitNotifier
{
public:

                                Application();

    virtual                     ~Application();

    virtual void                Init();

    virtual void                InitFinished();

    virtual void                DeInit();


    virtual int                 Main();

    virtual bool                QueryExit();

    virtual void                Shutdown();


    static void                 NotifyAllWindows( DataChangedEvent& rDCEvt );



    static sal_uInt16           GetCommandLineParamCount();

    static OUString             GetCommandLineParam( sal_uInt16 nParam );

    static OUString             GetAppFileName();


    virtual void          Exception( ExceptionCategory nCategory );

    static void                 Abort( const OUString& rErrorText );



    static void                 Execute();

    static void                 Quit();

    static bool                 IsQuit();

    static bool                 Reschedule( bool bHandleAllCurrentEvents = false );

    static void                 Yield();

    static void                 EndYield();

    static comphelper::SolarMutex& GetSolarMutex();

    static bool                 IsMainThread();

    static sal_uInt32           ReleaseSolarMutex();

    static void                 AcquireSolarMutex( sal_uInt32 nCount );

    static bool                 IsInMain();

    static bool                 IsInExecute();

    static bool                 IsInModalMode();

    static sal_uInt16           GetDispatchLevel();

    static bool                 AnyInput( VclInputFlags nType = VCL_INPUT_ANY );

    static sal_uInt64           GetLastInputInterval();


    /* Determines if the UI is captured.

     The UI is considered captured if a system dialog is open (e.g. printer setup),
     a floating window, menu or toolbox dropdown is open, or a window has been
     captured by the mouse.

     @returns   true if UI is captured, false if not
     */
    static bool                 IsUICaptured();


    virtual void                OverrideSystemSettings( AllSettings& rSettings );

    static void                 MergeSystemSettings( AllSettings& rSettings );

    static void                 SetSettings( const AllSettings& rSettings );

    static const AllSettings&   GetSettings();

    static const LocaleDataWrapper& GetAppLocaleDataWrapper();




    static void                 AddEventListener( const Link<VclSimpleEvent&,void>& rEventListener );

    static void                 RemoveEventListener( const Link<VclSimpleEvent&,void>& rEventListener );

    static void                 AddKeyListener( const Link<VclWindowEvent&,bool>& rKeyListener );

    static void                 RemoveKeyListener( const Link<VclWindowEvent&,bool>& rKeyListener );

    static void                 ImplCallEventListenersApplicationDataChanged( void* pData );

    static void                 ImplCallEventListeners( VclSimpleEvent& rEvent );

    static bool                 HandleKey( VclEventId nEvent, vcl::Window *pWin, KeyEvent* pKeyEvent );

    static ImplSVEvent *        PostKeyEvent( VclEventId nEvent, vcl::Window *pWin, KeyEvent const * pKeyEvent );


    static bool                 LOKHandleMouseEvent( VclEventId nEvent, vcl::Window *pWin, const MouseEvent* pEvent );

    static ImplSVEvent *        PostMouseEvent( VclEventId nEvent, vcl::Window *pWin, MouseEvent const * pMouseEvent );

    static ImplSVEvent* PostGestureEvent(VclEventId nEvent, vcl::Window* pWin, GestureEvent const * pGestureEvent);

    static void                 RemoveMouseAndKeyEvents( vcl::Window *pWin );

    static ImplSVEvent * PostUserEvent( const Link<void*,void>& rLink, void* pCaller = nullptr,
                                        bool bReferenceLink = false );

    static void                 RemoveUserEvent( ImplSVEvent * nUserEvent );

    /*** Get the DisplayConnection.

     It is a reference to XDisplayConnection, which allows toolkits to send display
     events to the application.

     @returns UNO reference to an object that implements the css:awt:XDisplayConnection
        interface.
    */
    static css::uno::Reference< css::awt::XDisplayConnection > GetDisplayConnection();

    virtual void                AppEvent( const ApplicationEvent& rAppEvent );



    static vcl::Window*              GetFocusWindow();

    static OutputDevice*        GetDefaultDevice();

    static vcl::Window*              GetFirstTopLevelWindow();

    static vcl::Window*              GetNextTopLevelWindow( vcl::Window const * pWindow );

    static tools::Long                 GetTopWindowCount();

    static vcl::Window*              GetTopWindow( tools::Long nIndex );

    static vcl::Window*              GetActiveTopWindow();


    static void                 SetAppName( const OUString& rUniqueName );



    static OUString             GetAppName();

    static OUString             GetOSVersion();

    static OUString             GetHWOSConfInfo(const int bSelection = 0, bool bLocalize = true);

    static bool                 LoadBrandBitmap (const char* pName, BitmapEx &rBitmap);



    static void                 SetDisplayName( const OUString& rDisplayName );

    static OUString             GetDisplayName();

    static OUString             GetToolkitName();

    static unsigned int         GetScreenCount();

    static tools::Rectangle            GetScreenPosSizePixel( unsigned int nScreen );

    static bool                 IsUnifiedDisplay();

    SAL_DLLPRIVATE static unsigned int GetBestScreen( const tools::Rectangle& );

    static unsigned int         GetDisplayBuiltInScreen();

    static unsigned int         GetDisplayExternalScreen();



    static bool                 InsertAccel( Accelerator* pAccel );

    static void                 RemoveAccel( Accelerator const * pAccel );

    static size_t               GetReservedKeyCodeCount();

    static const vcl::KeyCode*  GetReservedKeyCode( size_t i );



    static void                 SetHelp( Help* pHelp = nullptr );

    static Help*                GetHelp();



    static weld::Window*        GetDefDialogParent();


    static DialogCancelMode     GetDialogCancelMode();

    static void                 SetDialogCancelMode( DialogCancelMode mode );

    static bool                 IsDialogCancelEnabled();


    static void                 SetSystemWindowMode( SystemWindowFlags nMode );

    static SystemWindowFlags    GetSystemWindowMode();



    static css::uno::Reference< css::awt::XToolkit > GetVCLToolkit();



    /*** @name Graphic Filters
    */

    static void                 SetFilterHdl( const Link<ConvertData&,bool>& rLink );


    static void                 EnableHeadlessMode( bool dialogsAreFatal );

    static bool                 IsHeadlessModeEnabled();

    static void                 EnableConsoleOnly();

    static void                 EnableBitmapRendering();

    static bool                 IsBitmapRendering();


    static void                 EnableEventTestingMode();

    static bool                 IsEventTestingModeEnabled();

    static void                 EnableSafeMode();

    static bool                 IsSafeModeEnabled();


    static const OUString&      GetDesktopEnvironment();

    /*** @name Platform Functionality
    */

    static void                 AddToRecentDocumentList(const OUString& rFileUrl, const OUString& rMimeType, const OUString& rDocumentService);

    /*** Show a native error messagebox

     @param     sTitle          Title of error messagebox

     @param     sMessage        Message displayed in messagebox
    */
    static void                 ShowNativeErrorBox(const OUString& sTitle  ,
                                                   const OUString& sMessage);

    static void                 UpdateMainThread();

    static bool                 hasNativeFileSelection();

    static css::uno::Reference< css::ui::dialogs::XFilePicker2 >
        createFilePicker( const css::uno::Reference< css::uno::XComponentContext >& rServiceManager );

    static css::uno::Reference< css::ui::dialogs::XFolderPicker2 >
        createFolderPicker( const css::uno::Reference< css::uno::XComponentContext >& rServiceManager );

    static void                 EndAllDialogs();

    static void                 EndAllPopups();

    static bool IsOnSystemEventLoop();


    // For vclbootstrapprotector:
    static void setDeInitHook(Link<LinkParamNone*,void> const & hook);

    static std::unique_ptr<weld::Builder> CreateBuilder(weld::Widget* pParent, const OUString &rUIFile, bool bMobile = false, sal_uInt64 nLOKWindowId = 0);
    // For the duration of vcl parent windows
    static std::unique_ptr<weld::Builder> CreateInterimBuilder(vcl::Window* pParent, const OUString &rUIFile, bool bAllowCycleFocusOut, sal_uInt64 nLOKWindowId = 0);

    static weld::MessageDialog* CreateMessageDialog(weld::Widget* pParent, VclMessageType eMessageType,
                                                    VclButtonsType eButtonType, const OUString& rPrimaryMessage,
                                                    bool bMobile = false);

    static weld::Window* GetFrameWeld(const css::uno::Reference<css::awt::XWindow>& rWindow);

    // ILibreOfficeKitNotifier
    void* m_pCallbackData;
    LibreOfficeKitCallback m_pCallback;

    virtual void notifyWindow(vcl::LOKWindowId nLOKWindowId,
                              const OUString& rAction,
                              const std::vector<vcl::LOKPayloadItem>& rPayload = std::vector<vcl::LOKPayloadItem>()) const override;
    virtual void libreOfficeKitViewCallback(int nType, const char* pPayload) const override;

private:
    DECL_DLLPRIVATE_STATIC_LINK( Application, PostEventHandler, void*, void );
};

class SolarMutexGuard
    : public osl::Guard<comphelper::SolarMutex>
{
public:
    SolarMutexGuard()
        : osl::Guard<comphelper::SolarMutex>( Application::GetSolarMutex() ) {}
};

class SolarMutexClearableGuard
    : public osl::ClearableGuard<comphelper::SolarMutex>
{
public:
    SolarMutexClearableGuard()
        : osl::ClearableGuard<comphelper::SolarMutex>( Application::GetSolarMutex() ) {}
};

class SolarMutexResettableGuard
    : public osl::ResettableGuard<comphelper::SolarMutex>
{
public:
    SolarMutexResettableGuard()
        : osl::ResettableGuard<comphelper::SolarMutex>( Application::GetSolarMutex() ) {}
};

namespace vcl
{

class SolarMutexTryAndBuyGuard
{
private:
    bool m_isAcquired;
#ifdef DBG_UTIL
    bool m_isChecked;
#endif
    comphelper::SolarMutex& m_rSolarMutex;

    SolarMutexTryAndBuyGuard(const SolarMutexTryAndBuyGuard&) = delete;
    SolarMutexTryAndBuyGuard& operator=(const SolarMutexTryAndBuyGuard&) = delete;

public:

    SolarMutexTryAndBuyGuard()
        : m_isAcquired(false)
#ifdef DBG_UTIL
        , m_isChecked(false)
#endif
        , m_rSolarMutex(Application::GetSolarMutex())

    {
        m_isAcquired = m_rSolarMutex.tryToAcquire();
    }

    ~SolarMutexTryAndBuyGuard()
    {
#ifdef DBG_UTIL
        assert(m_isChecked);
#endif
        if (m_isAcquired)
            m_rSolarMutex.release();
    }

    bool isAcquired()
    {
#ifdef DBG_UTIL
        m_isChecked = true;
#endif
        return m_isAcquired;
    }
};

} // namespace vcl

class SolarMutexReleaser
{
    const sal_uInt32 mnReleased;
public:
    SolarMutexReleaser(): mnReleased(Application::ReleaseSolarMutex()) {}
    ~SolarMutexReleaser() { Application::AcquireSolarMutex( mnReleased ); }
};

VCL_DLLPUBLIC Application* GetpApp();

// returns true if vcl is already initialized
VCL_DLLPUBLIC bool IsVCLInit();
// returns true if vcl successfully initializes or was already initialized
VCL_DLLPUBLIC bool InitVCL();
VCL_DLLPUBLIC void DeInitVCL();

VCL_DLLPUBLIC bool InitAccessBridge();

// only allowed to call, if no thread is running. You must call JoinMainLoopThread to free all memory.
VCL_DLLPUBLIC void CreateMainLoopThread( oslWorkerFunction pWorker, void * pThreadData );
VCL_DLLPUBLIC void JoinMainLoopThread();

struct ImplSVHelpData;
VCL_DLLPUBLIC ImplSVHelpData* CreateSVHelpData();
VCL_DLLPUBLIC void DestroySVHelpData(ImplSVHelpData*);
VCL_DLLPUBLIC void SetSVHelpData(ImplSVHelpData*);

struct ImplSVWinData;
VCL_DLLPUBLIC ImplSVWinData* CreateSVWinData();
VCL_DLLPUBLIC void DestroySVWinData(ImplSVWinData*);
VCL_DLLPUBLIC void SetSVWinData(ImplSVWinData*);

inline void Application::EndYield()
{
    PostUserEvent( Link<void*,void>() );
}

#endif // _APP_HXX

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */