Adding upstream version 4:24.2.0.upstream/4%24.2.0

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>

1 files changed, 87 insertions, 0 deletions

diff --git a/sw/source/core/inc/observablethread.hxx b/sw/source/core/inc/observablethread.hxx
new file mode 100644
index 0000000000..3d10a7f384
--- /dev/null
+++ b/sw/source/core/inc/observablethread.hxx
@@ -0,0 +1,87 @@
+/* -*- 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_SW_SOURCE_CORE_INC_OBSERVABLETHREAD_HXX
+#define INCLUDED_SW_SOURCE_CORE_INC_OBSERVABLETHREAD_HXX
+
+#include <osl/thread.hxx>
+#include <osl/interlck.h>
+#include <salhelper/simplereferenceobject.hxx>
+#include <memory>
+
+class IFinishedThreadListener;
+
+/** class for an observable thread
+
+    OD 2007-01-29 #i73788#
+    Note: A thread is ref-counted. Thus, an instance of a derived class has to
+    to be hold via a reference. The thread itself assures during its execution,
+    that the ref-count is increased. Its execution starts with its <run()> method
+    and ends with its <onTerminated()> method.
+    Note: A thread can be only observed by one or none thread observer in order
+    to notify, that the thread has finished its work.
+*/
+class ObservableThread : public osl::Thread,
+                         public salhelper::SimpleReferenceObject
+{
+    public:
+
+        virtual ~ObservableThread() override;
+
+        void SetListener( std::weak_ptr< IFinishedThreadListener > const & pThreadListener,
+                          const oslInterlockedCount nThreadID );
+
+        // resolve ambiguity
+        using SimpleReferenceObject::operator new;
+        using SimpleReferenceObject::operator delete;
+
+    protected:
+
+        ObservableThread();
+
+        /** intrinsic function of the thread
+
+            Important note:
+            Do not override this method again. Instead override <threadFunction()>.
+            Otherwise, it's not guaranteed, that its ref-count is increased
+            during the execution of the thread.
+        */
+        virtual void SAL_CALL run() override;
+
+        virtual void threadFunction() = 0;
+
+        /** method called, when thread has finished its work
+
+            Important note:
+            Do not override this method again. Instead override <threadFinished()>.
+            Otherwise, it's not guaranteed, that the ref-count is decreased at
+            the end of its execution and that the observer is notified, that
+            the thread has finished its work.
+        */
+        virtual void SAL_CALL onTerminated() override;
+
+    private:
+
+        oslInterlockedCount mnThreadID;
+
+        std::weak_ptr< IFinishedThreadListener > mpThreadListener;
+
+};
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */