octave: liboctave/util/oct-mutex.h annotate

annotate liboctave/util/oct-mutex.h @ 33634:4a70f390c85e default tip @

maint: Merge stable to default.

author	Markus Mützel <markus.muetzel@gmx.de>
date	Tue, 28 May 2024 15:25:54 +0200
parents	4b601ca024d5
children

rev	line source
27923 bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	1 ////////////////////////////////////////////////////////////////////////
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	2 //
32632 2e484f9f1f18 maint: update Octave Project Developers copyright for the new year John W. Eaton <jwe@octave.org> parents: 31855 diff changeset	3 // Copyright (C) 2008-2024 The Octave Project Developers
27923 bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	4 //
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	5 // See the file COPYRIGHT.md in the top-level directory of this
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	6 // distribution or <https://octave.org/copyright/>.
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	7 //
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	8 // This file is part of Octave.
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	9 //
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	10 // Octave is free software: you can redistribute it and/or modify it
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	11 // under the terms of the GNU General Public License as published by
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	12 // the Free Software Foundation, either version 3 of the License, or
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	13 // (at your option) any later version.
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	14 //
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	15 // Octave is distributed in the hope that it will be useful, but
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	16 // WITHOUT ANY WARRANTY; without even the implied warranty of
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	17 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	18 // GNU General Public License for more details.
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	19 //
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	20 // You should have received a copy of the GNU General Public License
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	21 // along with Octave; see the file COPYING. If not, see
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	22 // <https://www.gnu.org/licenses/>.
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	23 //
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	24 ////////////////////////////////////////////////////////////////////////
7934 5a156ab94dd2 Add octave_mutex class John W. Eaton <jwe@octave.org> parents: diff changeset	25
20791 f7084eae3318 maint: Use Octave coding conventions for #if statements. Rik <rik@octave.org> parents: 19697 diff changeset	26 #if ! defined (octave_oct_mutex_h)
17822 ebb3ef964372 maint: Use common #define syntax "octave_filename_h" in h_files. Rik <rik@octave.org> parents: 17744 diff changeset	27 #define octave_oct_mutex_h 1
7934 5a156ab94dd2 Add octave_mutex class John W. Eaton <jwe@octave.org> parents: diff changeset	28
21244 1473547f50f5 include octave-config.h in public header files John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	29 #include "octave-config.h"
1473547f50f5 include octave-config.h in public header files John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	30
29565 7733ca1db419 use shared_ptr to manage memory for mutex object John W. Eaton <jwe@octave.org> parents: 29358 diff changeset	31 #include <memory>
13985 43cc49c7abd1 Use thread-safe atomic reference counting (GCC and MSVC). Michael Goffioul <michael.goffioul@gmail.com> parents: 13281 diff changeset	32
31605 e88a07dec498 maint: Use macros to begin/end C++ namespaces. Rik <rik@octave.org> parents: 31529 diff changeset	33 OCTAVE_BEGIN_NAMESPACE(octave)
e88a07dec498 maint: Use macros to begin/end C++ namespaces. Rik <rik@octave.org> parents: 31529 diff changeset	34
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	35 class mutex;
7952 2c0a0edae596 reorganize octave_mutex class John W. Eaton <jwe@octave.org> parents: 7943 diff changeset	36
32628 ae4e19c0a2b1 maint: Place class name and class keyword on one line. Rik <rik@octave.org> parents: 31855 diff changeset	37 class OCTAVE_API base_mutex
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	38 {
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	39 public:
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	40 friend class mutex;
7952 2c0a0edae596 reorganize octave_mutex class John W. Eaton <jwe@octave.org> parents: 7943 diff changeset	41
31855 1daf8bfceac3 default or disable more ctors, dtors, and assignment ops John W. Eaton <jwe@octave.org> parents: 31837 diff changeset	42 OCTAVE_DEFAULT_CONSTRUCT_COPY_MOVE (base_mutex)
13281 834f904a3dcb Add support for full asynchronous graphics toolkit running in a separate Michael Goffioul <michael.goffioul@gmail.com> parents: 11523 diff changeset	43
31771 21f9b34eb893 maint: Eliminate "(void)" in C++ function prototypes/declarations. Rik <rik@octave.org> parents: 31706 diff changeset	44 virtual ~base_mutex () = default;
23057 bb7513d73673 move mutex classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	45
31771 21f9b34eb893 maint: Eliminate "(void)" in C++ function prototypes/declarations. Rik <rik@octave.org> parents: 31706 diff changeset	46 virtual void lock ();
7952 2c0a0edae596 reorganize octave_mutex class John W. Eaton <jwe@octave.org> parents: 7943 diff changeset	47
31771 21f9b34eb893 maint: Eliminate "(void)" in C++ function prototypes/declarations. Rik <rik@octave.org> parents: 31706 diff changeset	48 virtual void unlock ();
23057 bb7513d73673 move mutex classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	49
31771 21f9b34eb893 maint: Eliminate "(void)" in C++ function prototypes/declarations. Rik <rik@octave.org> parents: 31706 diff changeset	50 virtual bool try_lock ();
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	51 };
7934 5a156ab94dd2 Add octave_mutex class John W. Eaton <jwe@octave.org> parents: diff changeset	52
32628 ae4e19c0a2b1 maint: Place class name and class keyword on one line. Rik <rik@octave.org> parents: 31855 diff changeset	53 class OCTAVE_API mutex
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	54 {
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	55 public:
31771 21f9b34eb893 maint: Eliminate "(void)" in C++ function prototypes/declarations. Rik <rik@octave.org> parents: 31706 diff changeset	56 mutex ();
7952 2c0a0edae596 reorganize octave_mutex class John W. Eaton <jwe@octave.org> parents: 7943 diff changeset	57
31855 1daf8bfceac3 default or disable more ctors, dtors, and assignment ops John W. Eaton <jwe@octave.org> parents: 31837 diff changeset	58 OCTAVE_DEFAULT_COPY_MOVE_DELETE (mutex)
23057 bb7513d73673 move mutex classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	59
31771 21f9b34eb893 maint: Eliminate "(void)" in C++ function prototypes/declarations. Rik <rik@octave.org> parents: 31706 diff changeset	60 void lock ()
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	61 {
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	62 m_rep->lock ();
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	63 }
7934 5a156ab94dd2 Add octave_mutex class John W. Eaton <jwe@octave.org> parents: diff changeset	64
31771 21f9b34eb893 maint: Eliminate "(void)" in C++ function prototypes/declarations. Rik <rik@octave.org> parents: 31706 diff changeset	65 void unlock ()
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	66 {
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	67 m_rep->unlock ();
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	68 }
7934 5a156ab94dd2 Add octave_mutex class John W. Eaton <jwe@octave.org> parents: diff changeset	69
31771 21f9b34eb893 maint: Eliminate "(void)" in C++ function prototypes/declarations. Rik <rik@octave.org> parents: 31706 diff changeset	70 bool try_lock ()
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	71 {
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	72 return m_rep->try_lock ();
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	73 }
23057 bb7513d73673 move mutex classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	74
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	75 protected:
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	76 std::shared_ptr<base_mutex> m_rep;
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	77 };
22869 f75d289645ec make deleted functions public John W. Eaton <jwe@octave.org> parents: 22868 diff changeset	78
32628 ae4e19c0a2b1 maint: Place class name and class keyword on one line. Rik <rik@octave.org> parents: 31855 diff changeset	79 class OCTAVE_API autolock
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	80 {
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	81 public:
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	82 autolock (const mutex& m, bool block = true)
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	83 : m_mutex (m), m_lock_result (false)
7952 2c0a0edae596 reorganize octave_mutex class John W. Eaton <jwe@octave.org> parents: 7943 diff changeset	84 {
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	85 if (block)
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	86 {
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	87 m_mutex.lock ();
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	88 m_lock_result = true;
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	89 }
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	90 else
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	91 m_lock_result = m_mutex.try_lock ();
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	92 }
7934 5a156ab94dd2 Add octave_mutex class John W. Eaton <jwe@octave.org> parents: diff changeset	93
31855 1daf8bfceac3 default or disable more ctors, dtors, and assignment ops John W. Eaton <jwe@octave.org> parents: 31837 diff changeset	94 OCTAVE_DISABLE_CONSTRUCT_COPY_MOVE (autolock)
13281 834f904a3dcb Add support for full asynchronous graphics toolkit running in a separate Michael Goffioul <michael.goffioul@gmail.com> parents: 11523 diff changeset	95
31771 21f9b34eb893 maint: Eliminate "(void)" in C++ function prototypes/declarations. Rik <rik@octave.org> parents: 31706 diff changeset	96 ~autolock ()
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	97 {
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	98 if (m_lock_result)
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	99 m_mutex.unlock ();
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	100 }
7936 78400fde223e Support for backend-to-octave event management John W. Eaton <jwe@octave.org> parents: 7934 diff changeset	101
31771 21f9b34eb893 maint: Eliminate "(void)" in C++ function prototypes/declarations. Rik <rik@octave.org> parents: 31706 diff changeset	102 bool ok () const { return m_lock_result; }
13281 834f904a3dcb Add support for full asynchronous graphics toolkit running in a separate Michael Goffioul <michael.goffioul@gmail.com> parents: 11523 diff changeset	103
31771 21f9b34eb893 maint: Eliminate "(void)" in C++ function prototypes/declarations. Rik <rik@octave.org> parents: 31706 diff changeset	104 operator bool () const { return ok (); }
7934 5a156ab94dd2 Add octave_mutex class John W. Eaton <jwe@octave.org> parents: diff changeset	105
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	106 private:
23057 bb7513d73673 move mutex classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	107
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	108 mutex m_mutex;
22865 89756f2f085b use c++11 style for deleting default copy constructor and assignment operator John W. Eaton <jwe@octave.org> parents: 22755 diff changeset	109
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	110 bool m_lock_result;
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	111 };
23057 bb7513d73673 move mutex classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	112
13281 834f904a3dcb Add support for full asynchronous graphics toolkit running in a separate Michael Goffioul <michael.goffioul@gmail.com> parents: 11523 diff changeset	113
32628 ae4e19c0a2b1 maint: Place class name and class keyword on one line. Rik <rik@octave.org> parents: 31855 diff changeset	114 class OCTAVE_API thread
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	115 {
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	116 public:
23057 bb7513d73673 move mutex classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	117
31771 21f9b34eb893 maint: Eliminate "(void)" in C++ function prototypes/declarations. Rik <rik@octave.org> parents: 31706 diff changeset	118 static void init ();
23057 bb7513d73673 move mutex classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	119
31771 21f9b34eb893 maint: Eliminate "(void)" in C++ function prototypes/declarations. Rik <rik@octave.org> parents: 31706 diff changeset	120 static bool is_thread ();
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	121 };
31605 e88a07dec498 maint: Use macros to begin/end C++ namespaces. Rik <rik@octave.org> parents: 31529 diff changeset	122
e88a07dec498 maint: Use macros to begin/end C++ namespaces. Rik <rik@octave.org> parents: 31529 diff changeset	123 OCTAVE_END_NAMESPACE(octave)
23057 bb7513d73673 move mutex classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	124
7934 5a156ab94dd2 Add octave_mutex class John W. Eaton <jwe@octave.org> parents: diff changeset	125 #endif

Mercurial > octave

annotate liboctave/util/oct-mutex.h @ 33634:4a70f390c85e default tip @