sfx2/source/appl/app.cxx

   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 #include <config_feature_desktop.h>
  21 #include <sal/log.hxx>
  22 #include <tools/debug.hxx>
  23
  24 #include <sfx2/app.hxx>
  25 #include <sfx2/frame.hxx>
  26 #include <basic/sberrors.hxx>
  27 #include <tools/svlibrary.h>
  28
  29 #include <svl/svdde.hxx>
  30 #include <unotools/configmgr.hxx>
  31 #include <com/sun/star/frame/XFrame.hpp>
  32 #include <comphelper/processfactory.hxx>
  33 #include <com/sun/star/uri/UriReferenceFactory.hpp>
  34 #include <com/sun/star/uri/XVndSunStarScriptUrl.hpp>
  35 #include <basic/basmgr.hxx>
  36 #include <vcl/svapp.hxx>
  37 #include <sfx2/sfxhelp.hxx>
  38 #include <sfx2/progress.hxx>
  39 #include <sfx2/objsh.hxx>
  40 #include <sfx2/dispatch.hxx>
  41 #include <sfx2/viewsh.hxx>
  42 #include <sfx2/viewfrm.hxx>
  43 #include <appdata.hxx>
  44 #include <sfx2/module.hxx>
  45 #include <sfx2/event.hxx>
  46 #include <workwin.hxx>
  47 #include <sfx2/sidebar/Theme.hxx>
  48 #include <sfx2/tbxctrl.hxx>
  49 #include <sfx2/sfxdlg.hxx>
  50 #include <sfx2/stbitem.hxx>
  51 #include <sfx2/dockwin.hxx>
  52 #include <shellimpl.hxx>
  53 #include <comphelper/lok.hxx>
  54
  55 #include <svtools/helpopt.hxx>
  56 #include <unotools/viewoptions.hxx>
  57 #include <rtl/instance.hxx>
  58 #include <rtl/strbuf.hxx>
  59 #include <memory>
  60 #include <framework/sfxhelperfunctions.hxx>
  61 #include <fwkhelper.hxx>
  62
  63 #include "getbasctlfunction.hxx"
  64
  65 using namespace ::com::sun::star;
  66
  67 static SfxApplication* g_pSfxApplication = nullptr;
  68
  69 #if HAVE_FEATURE_DESKTOP
  70 static SfxHelp*        pSfxHelp = nullptr;
  71 #endif
  72
  73 namespace
  74 {
  75     class theApplicationMutex
  76         : public rtl::Static<osl::Mutex, theApplicationMutex> {};
  77 }
  78
  79 SfxApplication* SfxApplication::Get()
  80 {
  81     return g_pSfxApplication;
  82 }
  83
  84 void SfxApplication::SetModule(SfxToolsModule nSharedLib, std::unique_ptr<SfxModule> pModule)
  85 {
  86     assert(g_pSfxApplication != nullptr);
  87
  88     g_pSfxApplication->pImpl->aModules[nSharedLib] = std::move(pModule);
  89 }
  90
  91 SfxModule* SfxApplication::GetModule(SfxToolsModule nSharedLib)
  92 {
  93     if (!g_pSfxApplication) // It is possible GetModule is called before SfxApplication is initialised via GetOrCreate()
  94         return nullptr;
  95     return g_pSfxApplication->pImpl->aModules[nSharedLib].get();
  96 }
  97
  98 SfxApplication* SfxApplication::GetOrCreate()
  99 {
 100     // SFX on demand
 101     ::osl::MutexGuard aGuard(theApplicationMutex::get());
 102     if (!g_pSfxApplication)
 103     {
 104         SAL_INFO( "sfx.appl", "SfxApplication::SetApp" );
 105
 106         g_pSfxApplication = new SfxApplication;
 107
 108         // at the moment a bug may occur when Initialize_Impl returns FALSE,
 109         // but this is only temporary because all code that may cause such
 110         // a fault will be moved outside the SFX
 111         g_pSfxApplication->Initialize_Impl();
 112
 113         ::framework::SetRefreshToolbars( RefreshToolbars );
 114         ::framework::SetToolBoxControllerCreator( SfxToolBoxControllerFactory );
 115         ::framework::SetStatusBarControllerCreator( SfxStatusBarControllerFactory );
 116         ::framework::SetDockingWindowCreator( SfxDockingWindowFactory );
 117         ::framework::SetIsDockingWindowVisible( IsDockingWindowVisible );
 118 #if HAVE_FEATURE_DESKTOP
 119         Application::SetHelp( pSfxHelp );
 120         if (!utl::ConfigManager::IsFuzzing() && SvtHelpOptions().IsHelpTips())
 121             Help::EnableQuickHelp();
 122         else
 123             Help::DisableQuickHelp();
 124         if (!utl::ConfigManager::IsFuzzing() && SvtHelpOptions().IsHelpTips() && SvtHelpOptions().IsExtendedHelp())
 125             Help::EnableBalloonHelp();
 126         else
 127             Help::DisableBalloonHelp();
 128 #endif
 129     }
 130     return g_pSfxApplication;
 131 }
 132
 133 SfxApplication::SfxApplication()
 134     : pImpl( new SfxAppData_Impl )
 135 {
 136     SetName( "StarOffice" );
 137     if (!utl::ConfigManager::IsFuzzing())
 138         SvtViewOptions::AcquireOptions();
 139
 140     SAL_INFO( "sfx.appl", "{ initialize DDE" );
 141
 142     bool bOk = InitializeDde();
 143
 144 #ifdef DBG_UTIL
 145     if( !bOk )
 146     {
 147         OStringBuffer aStr("No DDE-Service possible. Error: ");
 148         if( GetDdeService() )
 149             aStr.append(static_cast<sal_Int32>(GetDdeService()->GetError()));
 150         else
 151             aStr.append('?');
 152         SAL_WARN( "sfx.appl", aStr.getStr() );
 153     }
 154 #else
 155     (void)bOk;
 156 #endif
 157
 158 #if HAVE_FEATURE_DESKTOP
 159     pSfxHelp = new SfxHelp;
 160 #endif
 161
 162 #if HAVE_FEATURE_SCRIPTING
 163     StarBASIC::SetGlobalErrorHdl( LINK( this, SfxApplication, GlobalBasicErrorHdl_Impl ) );
 164 #endif
 165
 166     SAL_INFO( "sfx.appl", "} initialize DDE" );
 167 }
 168
 169 SfxApplication::~SfxApplication()
 170 {
 171     SAL_WARN_IF(GetObjectShells_Impl().size() != 0, "sfx.appl", "Memory leak: some object shells were not removed!");
 172
 173     Broadcast( SfxHint(SfxHintId::Dying) );
 174
 175     for (auto &module : pImpl->aModules)    // Clear modules
 176         module.reset();
 177
 178 #if HAVE_FEATURE_DESKTOP
 179     delete pSfxHelp;
 180     Application::SetHelp();
 181 #endif
 182
 183     // delete global options
 184     if (!utl::ConfigManager::IsFuzzing())
 185         SvtViewOptions::ReleaseOptions();
 186
 187     if ( !pImpl->bDowning )
 188         Deinitialize();
 189
 190     g_pSfxApplication = nullptr;
 191 }
 192
 193
 194 const OUString& SfxApplication::GetLastDir_Impl() const
 195
 196 /*  [Description]
 197
 198     Internal method by which the last set directory with the method
 199     <SfxApplication::SetLastDir_Impl()> in SFX is returned.
 200
 201     This is usually the most recently addressed by the
 202     SfxFileDialog directory.
 203
 204     [Cross-reference]
 205     <SfxApplication::SetLastDir_Impl()>
 206 */
 207
 208 {
 209     return pImpl->aLastDir;
 210 }
 211
 212 void SfxApplication::SetLastDir_Impl
 213 (
 214     const OUString&   rNewDir     /* Complete directory path as a string */
 215 )
 216
 217 /*  [Description]
 218
 219     Internal Method, by which a directory path is set that was last addressed
 220     (eg by the SfxFileDialog).
 221
 222     [Cross-reference]
 223     <SfxApplication::GetLastDir_Impl()>
 224 */
 225
 226 {
 227     pImpl->aLastDir = rNewDir;
 228 }
 229
 230
 231 void SfxApplication::ResetLastDir()
 232 {
 233     pImpl->aLastDir.clear();
 234 }
 235
 236
 237 SfxDispatcher* SfxApplication::GetDispatcher_Impl()
 238 {
 239     return pImpl->pViewFrame ? pImpl->pViewFrame->GetDispatcher() : pImpl->pAppDispat.get();
 240 }
 241
 242
 243 void SfxApplication::SetViewFrame_Impl( SfxViewFrame *pFrame )
 244 {
 245     if ( pFrame != pImpl->pViewFrame )
 246     {
 247         SfxViewFrame *pOldFrame = pImpl->pViewFrame;
 248
 249         // DocWinActivate : both frames belong to the same TopWindow
 250         // TopWinActivate : both frames belong to different TopWindows
 251
 252         bool bTaskActivate = pOldFrame != pFrame;
 253
 254         if ( pOldFrame )
 255         {
 256             if ( bTaskActivate )
 257                 NotifyEvent( SfxViewEventHint( SfxEventHintId::DeactivateDoc, GlobalEventConfig::GetEventName(GlobalEventId::DEACTIVATEDOC), pOldFrame->GetObjectShell(), pOldFrame->GetFrame().GetController() ) );
 258
 259             pOldFrame->DoDeactivate( bTaskActivate, pFrame );
 260
 261             if( pOldFrame->GetProgress() )
 262                 pOldFrame->GetProgress()->Suspend();
 263         }
 264
 265         pImpl->pViewFrame = pFrame;
 266
 267         if( pFrame )
 268         {
 269             pFrame->DoActivate( bTaskActivate );
 270             if ( bTaskActivate && pFrame->GetObjectShell() )
 271             {
 272                 pFrame->GetObjectShell()->PostActivateEvent_Impl( pFrame );
 273                 NotifyEvent(SfxViewEventHint(SfxEventHintId::ActivateDoc, GlobalEventConfig::GetEventName(GlobalEventId::ACTIVATEDOC), pFrame->GetObjectShell(), pFrame->GetFrame().GetController() ) );
 274             }
 275
 276             SfxProgress *pProgress = pFrame->GetProgress();
 277             if ( pProgress )
 278             {
 279                 if( pProgress->IsSuspended() )
 280                     pProgress->Resume();
 281                 else
 282                     pProgress->SetState( pProgress->GetState() );
 283             }
 284
 285             if ( pImpl->pViewFrame->GetViewShell() )
 286             {
 287                 SfxDispatcher* pDisp = pImpl->pViewFrame->GetDispatcher();
 288                 pDisp->Flush();
 289                 pDisp->Update_Impl(true);
 290             }
 291         }
 292     }
 293
 294     // even if the frame actually didn't change, ensure its document is forwarded
 295     // to SfxObjectShell::SetCurrentComponent.
 296     // Otherwise, the CurrentComponent might not be correct, in case it has meanwhile
 297     // been reset to some other document, by some non-SFX component. #i49133#
 298     if ( pFrame && pFrame->GetViewShell() )
 299         pFrame->GetViewShell()->SetCurrentDocument();
 300 }
 301
 302 void SfxApplication::SetProgress_Impl
 303 (
 304     SfxProgress *pProgress
 305 )
 306 {
 307     DBG_ASSERT( ( !pImpl->pProgress && pProgress ) ||
 308                 ( pImpl->pProgress && !pProgress ),
 309                 "Progress activation/deactivation mismatch" );
 310
 311     if ( pImpl->pProgress && pProgress )
 312     {
 313         pImpl->pProgress->Suspend();
 314         delete pImpl->pProgress;
 315     }
 316
 317     pImpl->pProgress = pProgress;
 318 }
 319
 320
 321 sal_uInt16 SfxApplication::GetFreeIndex()
 322 {
 323     return pImpl->aIndexBitSet.GetFreeIndex()+1;
 324 }
 325
 326
 327 void SfxApplication::ReleaseIndex(sal_uInt16 i)
 328 {
 329     pImpl->aIndexBitSet.ReleaseIndex(i-1);
 330 }
 331
 332
 333 vcl::Window* SfxApplication::GetTopWindow() const
 334 {
 335     SfxWorkWindow* pWork = GetWorkWindow_Impl( SfxViewFrame::Current() );
 336     return pWork ? pWork->GetWindow() : nullptr;
 337 }
 338
 339 SfxTbxCtrlFactArr_Impl&     SfxApplication::GetTbxCtrlFactories_Impl() const
 340 {
 341     return *pImpl->pTbxCtrlFac;
 342 }
 343
 344 SfxStbCtrlFactArr_Impl&     SfxApplication::GetStbCtrlFactories_Impl() const
 345 {
 346     return *pImpl->pStbCtrlFac;
 347 }
 348
 349 SfxViewFrameArr_Impl&       SfxApplication::GetViewFrames_Impl() const
 350 {
 351     return *pImpl->pViewFrames;
 352 }
 353
 354 SfxViewShellArr_Impl&       SfxApplication::GetViewShells_Impl() const
 355 {
 356     return *pImpl->pViewShells;
 357 }
 358
 359 SfxObjectShellArr_Impl&     SfxApplication::GetObjectShells_Impl() const
 360 {
 361     return *pImpl->pObjShells;
 362 }
 363
 364 void SfxApplication::Invalidate( sal_uInt16 nId )
 365 {
 366     for( SfxViewFrame* pFrame = SfxViewFrame::GetFirst(); pFrame; pFrame = SfxViewFrame::GetNext( *pFrame ) )
 367         Invalidate_Impl( pFrame->GetBindings(), nId );
 368 }
 369
 370 #if HAVE_FEATURE_SCRIPTING
 371
 372 #ifndef DISABLE_DYNLOADING
 373
 374 typedef long (*basicide_handle_basic_error)(void const *);
 375 typedef void (*basicide_macro_organizer)(void *, sal_Int16);
 376
 377 #else
 378
 379 extern "C" long basicide_handle_basic_error(void const*);
 380 extern "C" void basicide_macro_organizer(void*, sal_Int16);
 381
 382 #endif
 383
 384 #endif
 385
 386 IMPL_STATIC_LINK( SfxApplication, GlobalBasicErrorHdl_Impl, StarBASIC*, pStarBasic, bool )
 387 {
 388 #if !HAVE_FEATURE_SCRIPTING
 389     (void) pStarBasic;
 390     return false;
 391 #else
 392
 393 #ifndef DISABLE_DYNLOADING
 394     basicide_handle_basic_error pSymbol = reinterpret_cast<basicide_handle_basic_error>(sfx2::getBasctlFunction("basicide_handle_basic_error"));
 395
 396     // call basicide_handle_basic_error in basctl
 397     bool bRet = pSymbol( pStarBasic );
 398
 399 #else
 400
 401     bool bRet = basicide_handle_basic_error( pStarBasic );
 402
 403 #endif
 404
 405     return bRet;
 406
 407 #endif
 408 }
 409
 410 bool SfxApplication::IsXScriptURL( const OUString& rScriptURL )
 411 {
 412     bool result = false;
 413
 414 #if !HAVE_FEATURE_SCRIPTING
 415     (void) rScriptURL;
 416 #else
 417     css::uno::Reference< css::uno::XComponentContext > xContext =
 418             ::comphelper::getProcessComponentContext();
 419
 420     css::uno::Reference< css::uri::XUriReferenceFactory >
 421             xFactory = css::uri::UriReferenceFactory::create( xContext );
 422
 423     try
 424     {
 425         css::uno::Reference< css::uri::XVndSunStarScriptUrl >
 426                 xUrl( xFactory->parse( rScriptURL ),  css::uno::UNO_QUERY );
 427
 428         if ( xUrl.is() )
 429         {
 430             result = true;
 431         }
 432     }
 433     catch (const css::uno::RuntimeException&)
 434     {
 435         // ignore, will just return FALSE
 436     }
 437 #endif
 438     return result;
 439 }
 440
 441 OUString
 442 SfxApplication::ChooseScript(weld::Window *pParent)
 443 {
 444     OUString aScriptURL;
 445
 446 #if HAVE_FEATURE_SCRIPTING
 447     SfxAbstractDialogFactory* pFact = SfxAbstractDialogFactory::Create();
 448     SAL_INFO( "sfx.appl", "create selector dialog");
 449
 450     const SfxViewFrame* pViewFrame = SfxViewFrame::Current();
 451     const SfxFrame* pFrame = pViewFrame ? &pViewFrame->GetFrame() : nullptr;
 452     uno::Reference< frame::XFrame > xFrame( pFrame ? pFrame->GetFrameInterface() : uno::Reference< frame::XFrame >() );
 453
 454     ScopedVclPtr<AbstractScriptSelectorDialog> pDlg(pFact->CreateScriptSelectorDialog(pParent, xFrame));
 455
 456     SAL_INFO( "sfx.appl", "done, now exec it");
 457
 458     sal_uInt16 nRet = pDlg->Execute();
 459
 460     SAL_INFO( "sfx.appl", "has returned");
 461
 462     if ( nRet == RET_OK )
 463     {
 464         aScriptURL = pDlg->GetScriptURL();
 465     }
 466 #else
 467     (void) pParent;
 468 #endif
 469     return aScriptURL;
 470 }
 471
 472 void SfxApplication::MacroOrganizer(weld::Window* pParent, sal_Int16 nTabId)
 473 {
 474 #if !HAVE_FEATURE_SCRIPTING
 475     (void) pParent;
 476     (void) nTabId;
 477 #else
 478
 479 #ifndef DISABLE_DYNLOADING
 480     basicide_macro_organizer pSymbol = reinterpret_cast<basicide_macro_organizer>(sfx2::getBasctlFunction("basicide_macro_organizer"));
 481
 482     // call basicide_macro_organizer in basctl
 483     pSymbol(pParent, nTabId);
 484
 485 #else
 486
 487     basicide_macro_organizer(pParent, nTabId);
 488
 489 #endif
 490
 491 #endif
 492 }
 493
 494 ErrCode SfxApplication::CallBasic( const OUString& rCode, BasicManager* pMgr, SbxArray* pArgs, SbxValue* pRet )
 495 {
 496 #if !HAVE_FEATURE_SCRIPTING
 497     (void) rCode;
 498     (void) pMgr;
 499     (void) pArgs;
 500     (void) pRet;
 501     return ERRCODE_BASIC_CANNOT_LOAD;
 502 #else
 503     (void) ERRCODE_BASIC_CANNOT_LOAD; // So that the !HAVE_FEATURE_SCRIPTING case isn't broken again by IWYU
 504     return pMgr->ExecuteMacro( rCode, pArgs, pRet);
 505 #endif
 506 }
 507
 508 sfx2::sidebar::Theme & SfxApplication::GetSidebarTheme()
 509 {
 510     if (!pImpl->m_pSidebarTheme.is())
 511     {
 512         pImpl->m_pSidebarTheme.set(new sfx2::sidebar::Theme);
 513         pImpl->m_pSidebarTheme->InitializeTheme();
 514     }
 515     return *pImpl->m_pSidebarTheme;
 516 }
 517
 518 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */