sw/source/core/inc/swthreadmanager.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 #ifndef INCLUDED_SW_SOURCE_CORE_INC_SWTHREADMANAGER_HXX
  20 #define INCLUDED_SW_SOURCE_CORE_INC_SWTHREADMANAGER_HXX
  21
  22 #include <osl/interlck.h>
  23
  24 #include <memory>
  25
  26 namespace rtl { template <class reference_type> class Reference; }
  27
  28 class ObservableThread;
  29 class ThreadManager;
  30
  31 /** class to manage threads in Writer using a <ThreadManager> instance
  32
  33     #i73788#
  34     Conforms the singleton pattern
  35 */
  36 class SwThreadManager
  37 {
  38     public:
  39
  40         static SwThreadManager& GetThreadManager();
  41
  42         static bool ExistsThreadManager();
  43
  44         // private: don't call!
  45         SwThreadManager();
  46         // private: don't call!
  47         ~SwThreadManager();
  48
  49         oslInterlockedCount AddThread( const rtl::Reference< ObservableThread >& rThread );
  50
  51         void RemoveThread( const oslInterlockedCount nThreadID );
  52
  53         /** suspend the starting of threads
  54
  55             Suspending the starting of further threads is sensible during the
  56             destruction of a Writer document.
  57         */
  58         void SuspendStartingOfThreads();
  59
  60         /** continues the starting of threads after it has been suspended
  61         */
  62         void ResumeStartingOfThreads();
  63
  64         bool StartingOfThreadsSuspended();
  65
  66     private:
  67
  68         SwThreadManager(SwThreadManager const&) = delete;
  69         SwThreadManager& operator=(SwThreadManager const&) = delete;
  70
  71         static bool sbThreadManagerInstantiated;
  72
  73         std::unique_ptr<ThreadManager> mpThreadManagerImpl;
  74
  75 };
  76 #endif
  77
  78 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */