Line data    Source code

       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             : 
      10             : #ifndef INCLUDED_SALHELPER_THREAD_HXX
      11             : #define INCLUDED_SALHELPER_THREAD_HXX
      12             : 
      13             : #include "sal/config.h"
      14             : 
      15             : #include <cstddef>
      16             : 
      17             : #include "osl/thread.hxx"
      18             : #include "sal/types.h"
      19             : #include "salhelper/salhelperdllapi.h"
      20             : #include "salhelper/simplereferenceobject.hxx"
      21             : 
      22             : namespace salhelper {
      23             : 
      24             : /**
      25             :    A safe encapsulation of ::osl::Thread.
      26             : 
      27             :    @since LibreOffice 3.6
      28             : */
      29             : class SALHELPER_DLLPUBLIC Thread:
      30             :     public salhelper::SimpleReferenceObject, private osl::Thread
      31             : {
      32             : public:
      33             :     /**
      34             :        @param name the thread name, see ::osl_setThreadName; must be a non-null
      35             :        null terminated string
      36             :      */
      37             :     Thread(char const * name);
      38             : 
      39             :     /**
      40             :        Launch the thread.
      41             : 
      42             :        This function must be called at most once.
      43             : 
      44             :        Each call of this function should eventually be followed by a call to
      45             :        ::osl::Thread::join before exit(3), to ensure the thread is no longer
      46             :        relying on any infrastructure while that infrastructure is being shut
      47             :        down in atexit handlers.
      48             :     */
      49             :     void launch();
      50             : 
      51             :     using osl::Thread::getIdentifier;
      52             :     using osl::Thread::join;
      53             :     using osl::Thread::schedule;
      54             :     using osl::Thread::terminate;
      55             : 
      56             :     // While the below static member functions should arguably always be called
      57             :     // with qualified (osl::Thread) names, compilers would still complain that
      58             :     // they are inaccessible from within derivations of salhelper::Thread (an
      59             :     // alternative would be to force such derivations to use global names,
      60             :     // prefixed with ::osl::Thread):
      61             :     using osl::Thread::getCurrentIdentifier;
      62             :     using osl::Thread::wait;
      63             :     using osl::Thread::yield;
      64             : 
      65        1927 :     static inline void * operator new(std::size_t size)
      66        1927 :     { return SimpleReferenceObject::operator new(size); }
      67             : 
      68        1925 :     static inline void operator delete(void * pointer)
      69        1925 :     { SimpleReferenceObject::operator delete(pointer); }
      70             : 
      71             : protected:
      72             :     virtual ~Thread();
      73             : 
      74             :     /**
      75             :        The main function executed by the thread.
      76             : 
      77             :        Any uncaught exceptions lead to std::terminate.
      78             :     */
      79             :     virtual void execute() = 0;
      80             : 
      81             : private:
      82             :     virtual void SAL_CALL run();
      83             : 
      84             :     virtual void SAL_CALL onTerminated();
      85             : 
      86             :     char const * name_;
      87             : };
      88             : 
      89             : }
      90             : 
      91             : #endif
      92             : 
      93             : /* vim:set shiftwidth=4 softtabstop=4 expandtab: */