office-gobmx/include/salhelper/thread.hxx
Stephan Bergmann 70cc2b191b First batch of adding SAL_OVERRRIDE to overriding function declarations
...mostly done with a rewriting Clang plugin, with just some manual tweaking
necessary to fix poor macro usage.

Change-Id: I71fa20213e86be10de332ece0aa273239df7b61a
2014-03-26 16:39:26 +01:00

93 lines
2.5 KiB
C++

/* -*- 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/.
*/
#ifndef INCLUDED_SALHELPER_THREAD_HXX
#define INCLUDED_SALHELPER_THREAD_HXX
#include <sal/config.h>
#include <cstddef>
#include <osl/thread.hxx>
#include <sal/types.h>
#include <salhelper/salhelperdllapi.h>
#include <salhelper/simplereferenceobject.hxx>
namespace salhelper {
/**
A safe encapsulation of ::osl::Thread.
@since LibreOffice 3.6
*/
class SALHELPER_DLLPUBLIC Thread:
public salhelper::SimpleReferenceObject, private osl::Thread
{
public:
/**
@param name the thread name, see ::osl_setThreadName; must be a non-null
null terminated string
*/
Thread(char const * name);
/**
Launch the thread.
This function must be called at most once.
Each call of this function should eventually be followed by a call to
::osl::Thread::join before exit(3), to ensure the thread is no longer
relying on any infrastructure while that infrastructure is being shut
down in atexit handlers.
*/
void launch();
using osl::Thread::getIdentifier;
using osl::Thread::join;
using osl::Thread::schedule;
using osl::Thread::terminate;
// While the below static member functions should arguably always be called
// with qualified (osl::Thread) names, compilers would still complain that
// they are inaccessible from within derivations of salhelper::Thread (an
// alternative would be to force such derivations to use global names,
// prefixed with ::osl::Thread):
using osl::Thread::getCurrentIdentifier;
using osl::Thread::wait;
using osl::Thread::yield;
static inline void * operator new(std::size_t size)
{ return SimpleReferenceObject::operator new(size); }
static inline void operator delete(void * pointer)
{ SimpleReferenceObject::operator delete(pointer); }
protected:
virtual ~Thread();
/**
The main function executed by the thread.
Any uncaught exceptions lead to std::terminate.
*/
virtual void execute() = 0;
private:
virtual void SAL_CALL run() SAL_OVERRIDE;
virtual void SAL_CALL onTerminated() SAL_OVERRIDE;
char const * name_;
};
}
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */