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

annotate liboctave/util/oct-mutex.h @ 27919:1891570abac8

update Octave Project Developers copyright for the new year In files that have the "Octave Project Developers" copyright notice, update for 2020.

author	John W. Eaton <jwe@octave.org>
date	Mon, 06 Jan 2020 22:29:51 -0500
parents	b442ec6dda5c
children	bd51beb6205e

rev	line source
7934 5a156ab94dd2 Add octave_mutex class John W. Eaton <jwe@octave.org> parents: diff changeset	1 /*
5a156ab94dd2 Add octave_mutex class John W. Eaton <jwe@octave.org> parents: diff changeset	2
27919 1891570abac8 update Octave Project Developers copyright for the new year John W. Eaton <jwe@octave.org> parents: 27918 diff changeset	3 Copyright (C) 2008-2020 The Octave Project Developers
27918 b442ec6dda5c use centralized file for copyright info for individual contributors John W. Eaton <jwe@octave.org> parents: 27446 diff changeset	4
b442ec6dda5c use centralized file for copyright info for individual contributors John W. Eaton <jwe@octave.org> parents: 27446 diff changeset	5 See the file COPYRIGHT.md in the top-level directory of this distribution
b442ec6dda5c use centralized file for copyright info for individual contributors John W. Eaton <jwe@octave.org> parents: 27446 diff changeset	6 or <https://octave.org/COPYRIGHT.html/>.
b442ec6dda5c use centralized file for copyright info for individual contributors John W. Eaton <jwe@octave.org> parents: 27446 diff changeset	7
7934 5a156ab94dd2 Add octave_mutex class John W. Eaton <jwe@octave.org> parents: diff changeset	8
5a156ab94dd2 Add octave_mutex class John W. Eaton <jwe@octave.org> parents: diff changeset	9 This file is part of Octave.
5a156ab94dd2 Add octave_mutex class John W. Eaton <jwe@octave.org> parents: diff changeset	10
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 23696 diff changeset	11 Octave is free software: you can redistribute it and/or modify it
22755 3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22402 diff changeset	12 under the terms of the GNU General Public License as published by
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 23696 diff changeset	13 the Free Software Foundation, either version 3 of the License, or
22755 3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22402 diff changeset	14 (at your option) any later version.
7934 5a156ab94dd2 Add octave_mutex class John W. Eaton <jwe@octave.org> parents: diff changeset	15
22755 3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22402 diff changeset	16 Octave is distributed in the hope that it will be useful, but
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22402 diff changeset	17 WITHOUT ANY WARRANTY; without even the implied warranty of
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22402 diff changeset	18 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22402 diff changeset	19 GNU General Public License for more details.
7934 5a156ab94dd2 Add octave_mutex class John W. Eaton <jwe@octave.org> parents: diff changeset	20
5a156ab94dd2 Add octave_mutex class John W. Eaton <jwe@octave.org> parents: diff changeset	21 You should have received a copy of the GNU General Public License
5a156ab94dd2 Add octave_mutex class John W. Eaton <jwe@octave.org> parents: diff changeset	22 along with Octave; see the file COPYING. If not, see
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 23696 diff changeset	23 <https://www.gnu.org/licenses/>.
7934 5a156ab94dd2 Add octave_mutex class John W. Eaton <jwe@octave.org> parents: diff changeset	24
5a156ab94dd2 Add octave_mutex class John W. Eaton <jwe@octave.org> parents: diff changeset	25 */
5a156ab94dd2 Add octave_mutex class John W. Eaton <jwe@octave.org> parents: diff changeset	26
20791 f7084eae3318 maint: Use Octave coding conventions for #if statements. Rik <rik@octave.org> parents: 19697 diff changeset	27 #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	28 #define octave_oct_mutex_h 1
7934 5a156ab94dd2 Add octave_mutex class John W. Eaton <jwe@octave.org> parents: diff changeset	29
21244 1473547f50f5 include octave-config.h in public header files John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	30 #include "octave-config.h"
1473547f50f5 include octave-config.h in public header files John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	31
13985 43cc49c7abd1 Use thread-safe atomic reference counting (GCC and MSVC). Michael Goffioul <michael.goffioul@gmail.com> parents: 13281 diff changeset	32 #include "oct-refcount.h"
43cc49c7abd1 Use thread-safe atomic reference counting (GCC and MSVC). Michael Goffioul <michael.goffioul@gmail.com> parents: 13281 diff changeset	33
23057 bb7513d73673 move mutex classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	34 namespace octave
7952 2c0a0edae596 reorganize octave_mutex class John W. Eaton <jwe@octave.org> parents: 7943 diff changeset	35 {
23057 bb7513d73673 move mutex classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	36 class mutex;
7952 2c0a0edae596 reorganize octave_mutex class John W. Eaton <jwe@octave.org> parents: 7943 diff changeset	37
23057 bb7513d73673 move mutex classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	38 class
bb7513d73673 move mutex classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	39 base_mutex
bb7513d73673 move mutex classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	40 {
bb7513d73673 move mutex classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	41 public:
bb7513d73673 move mutex classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	42 friend class mutex;
7952 2c0a0edae596 reorganize octave_mutex class John W. Eaton <jwe@octave.org> parents: 7943 diff changeset	43
27379 3db033e86376 use m_ prefix for data members in most liboctave/util classes John W. Eaton <jwe@octave.org> parents: 26377 diff changeset	44 base_mutex (void) : m_count (1) { }
13281 834f904a3dcb Add support for full asynchronous graphics toolkit running in a separate Michael Goffioul <michael.goffioul@gmail.com> parents: 11523 diff changeset	45
23057 bb7513d73673 move mutex classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	46 virtual ~base_mutex (void) = default;
bb7513d73673 move mutex classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	47
bb7513d73673 move mutex classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	48 virtual void lock (void);
7952 2c0a0edae596 reorganize octave_mutex class John W. Eaton <jwe@octave.org> parents: 7943 diff changeset	49
23057 bb7513d73673 move mutex classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	50 virtual void unlock (void);
bb7513d73673 move mutex classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	51
bb7513d73673 move mutex classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	52 virtual bool try_lock (void);
7952 2c0a0edae596 reorganize octave_mutex class John W. Eaton <jwe@octave.org> parents: 7943 diff changeset	53
23057 bb7513d73673 move mutex classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	54 private:
27446 c23aee2104de consistently use octave_idx_type for reference counts John W. Eaton <jwe@octave.org> parents: 27379 diff changeset	55 refcount<octave_idx_type> m_count;
23057 bb7513d73673 move mutex classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	56 };
7934 5a156ab94dd2 Add octave_mutex class John W. Eaton <jwe@octave.org> parents: diff changeset	57
23057 bb7513d73673 move mutex classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	58 class
bb7513d73673 move mutex classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	59 OCTAVE_API
bb7513d73673 move mutex classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	60 mutex
7952 2c0a0edae596 reorganize octave_mutex class John W. Eaton <jwe@octave.org> parents: 7943 diff changeset	61 {
23057 bb7513d73673 move mutex classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	62 public:
bb7513d73673 move mutex classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	63 mutex (void);
7952 2c0a0edae596 reorganize octave_mutex class John W. Eaton <jwe@octave.org> parents: 7943 diff changeset	64
23057 bb7513d73673 move mutex classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	65 mutex (const mutex& m)
27379 3db033e86376 use m_ prefix for data members in most liboctave/util classes John W. Eaton <jwe@octave.org> parents: 26377 diff changeset	66 : m_rep (m.m_rep)
25103 078b795c5219 maint: style check C++ ahead of 4.4 release. Rik <rik@octave.org> parents: 25054 diff changeset	67 {
27379 3db033e86376 use m_ prefix for data members in most liboctave/util classes John W. Eaton <jwe@octave.org> parents: 26377 diff changeset	68 m_rep->m_count++;
25103 078b795c5219 maint: style check C++ ahead of 4.4 release. Rik <rik@octave.org> parents: 25054 diff changeset	69 }
7934 5a156ab94dd2 Add octave_mutex class John W. Eaton <jwe@octave.org> parents: diff changeset	70
23057 bb7513d73673 move mutex classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	71 ~mutex (void)
25103 078b795c5219 maint: style check C++ ahead of 4.4 release. Rik <rik@octave.org> parents: 25054 diff changeset	72 {
27379 3db033e86376 use m_ prefix for data members in most liboctave/util classes John W. Eaton <jwe@octave.org> parents: 26377 diff changeset	73 if (--m_rep->m_count == 0)
3db033e86376 use m_ prefix for data members in most liboctave/util classes John W. Eaton <jwe@octave.org> parents: 26377 diff changeset	74 delete m_rep;
25103 078b795c5219 maint: style check C++ ahead of 4.4 release. Rik <rik@octave.org> parents: 25054 diff changeset	75 }
7934 5a156ab94dd2 Add octave_mutex class John W. Eaton <jwe@octave.org> parents: diff changeset	76
23057 bb7513d73673 move mutex classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	77 mutex& operator = (const mutex& m)
25103 078b795c5219 maint: style check C++ ahead of 4.4 release. Rik <rik@octave.org> parents: 25054 diff changeset	78 {
27379 3db033e86376 use m_ prefix for data members in most liboctave/util classes John W. Eaton <jwe@octave.org> parents: 26377 diff changeset	79 if (m_rep != m.m_rep)
25103 078b795c5219 maint: style check C++ ahead of 4.4 release. Rik <rik@octave.org> parents: 25054 diff changeset	80 {
27379 3db033e86376 use m_ prefix for data members in most liboctave/util classes John W. Eaton <jwe@octave.org> parents: 26377 diff changeset	81 if (--m_rep->m_count == 0)
3db033e86376 use m_ prefix for data members in most liboctave/util classes John W. Eaton <jwe@octave.org> parents: 26377 diff changeset	82 delete m_rep;
7934 5a156ab94dd2 Add octave_mutex class John W. Eaton <jwe@octave.org> parents: diff changeset	83
27379 3db033e86376 use m_ prefix for data members in most liboctave/util classes John W. Eaton <jwe@octave.org> parents: 26377 diff changeset	84 m_rep = m.m_rep;
3db033e86376 use m_ prefix for data members in most liboctave/util classes John W. Eaton <jwe@octave.org> parents: 26377 diff changeset	85 m_rep->m_count++;
25103 078b795c5219 maint: style check C++ ahead of 4.4 release. Rik <rik@octave.org> parents: 25054 diff changeset	86 }
23057 bb7513d73673 move mutex classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	87
25103 078b795c5219 maint: style check C++ ahead of 4.4 release. Rik <rik@octave.org> parents: 25054 diff changeset	88 return *this;
078b795c5219 maint: style check C++ ahead of 4.4 release. Rik <rik@octave.org> parents: 25054 diff changeset	89 }
23057 bb7513d73673 move mutex classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	90
bb7513d73673 move mutex classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	91 void lock (void)
bb7513d73673 move mutex classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	92 {
27379 3db033e86376 use m_ prefix for data members in most liboctave/util classes John W. Eaton <jwe@octave.org> parents: 26377 diff changeset	93 m_rep->lock ();
23057 bb7513d73673 move mutex classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	94 }
7934 5a156ab94dd2 Add octave_mutex class John W. Eaton <jwe@octave.org> parents: diff changeset	95
23057 bb7513d73673 move mutex classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	96 void unlock (void)
bb7513d73673 move mutex classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	97 {
27379 3db033e86376 use m_ prefix for data members in most liboctave/util classes John W. Eaton <jwe@octave.org> parents: 26377 diff changeset	98 m_rep->unlock ();
23057 bb7513d73673 move mutex classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	99 }
7934 5a156ab94dd2 Add octave_mutex class John W. Eaton <jwe@octave.org> parents: diff changeset	100
23057 bb7513d73673 move mutex classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	101 bool try_lock (void)
bb7513d73673 move mutex classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	102 {
27379 3db033e86376 use m_ prefix for data members in most liboctave/util classes John W. Eaton <jwe@octave.org> parents: 26377 diff changeset	103 return m_rep->try_lock ();
23057 bb7513d73673 move mutex classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	104 }
bb7513d73673 move mutex classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	105
bb7513d73673 move mutex classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	106 protected:
27379 3db033e86376 use m_ prefix for data members in most liboctave/util classes John W. Eaton <jwe@octave.org> parents: 26377 diff changeset	107 base_mutex *m_rep;
23057 bb7513d73673 move mutex classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	108 };
22869 f75d289645ec make deleted functions public John W. Eaton <jwe@octave.org> parents: 22868 diff changeset	109
23057 bb7513d73673 move mutex classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	110 class
bb7513d73673 move mutex classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	111 autolock
7952 2c0a0edae596 reorganize octave_mutex class John W. Eaton <jwe@octave.org> parents: 7943 diff changeset	112 {
23057 bb7513d73673 move mutex classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	113 public:
bb7513d73673 move mutex classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	114 autolock (const mutex& m, bool block = true)
bb7513d73673 move mutex classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	115 : m_mutex (m), m_lock_result (false)
bb7513d73673 move mutex classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	116 {
bb7513d73673 move mutex classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	117 if (block)
bb7513d73673 move mutex classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	118 {
bb7513d73673 move mutex classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	119 m_mutex.lock ();
bb7513d73673 move mutex classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	120 m_lock_result = true;
bb7513d73673 move mutex classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	121 }
bb7513d73673 move mutex classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	122 else
bb7513d73673 move mutex classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	123 m_lock_result = m_mutex.try_lock ();
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
23057 bb7513d73673 move mutex classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	126 // No copying.
13281 834f904a3dcb Add support for full asynchronous graphics toolkit running in a separate Michael Goffioul <michael.goffioul@gmail.com> parents: 11523 diff changeset	127
23057 bb7513d73673 move mutex classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	128 autolock (const autolock&) = delete;
13281 834f904a3dcb Add support for full asynchronous graphics toolkit running in a separate Michael Goffioul <michael.goffioul@gmail.com> parents: 11523 diff changeset	129
23057 bb7513d73673 move mutex classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	130 autolock& operator = (const autolock&) = delete;
7936 78400fde223e Support for backend-to-octave event management John W. Eaton <jwe@octave.org> parents: 7934 diff changeset	131
23057 bb7513d73673 move mutex classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	132 ~autolock (void)
bb7513d73673 move mutex classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	133 {
bb7513d73673 move mutex classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	134 if (m_lock_result)
bb7513d73673 move mutex classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	135 m_mutex.unlock ();
bb7513d73673 move mutex classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	136 }
13281 834f904a3dcb Add support for full asynchronous graphics toolkit running in a separate Michael Goffioul <michael.goffioul@gmail.com> parents: 11523 diff changeset	137
23057 bb7513d73673 move mutex classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	138 bool ok (void) const { return m_lock_result; }
7934 5a156ab94dd2 Add octave_mutex class John W. Eaton <jwe@octave.org> parents: diff changeset	139
23057 bb7513d73673 move mutex classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	140 operator bool (void) const { return ok (); }
bb7513d73673 move mutex classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	141
bb7513d73673 move mutex classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	142 private:
22865 89756f2f085b use c++11 style for deleting default copy constructor and assignment operator John W. Eaton <jwe@octave.org> parents: 22755 diff changeset	143
23057 bb7513d73673 move mutex classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	144 mutex m_mutex;
bb7513d73673 move mutex classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	145
bb7513d73673 move mutex classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	146 bool m_lock_result;
bb7513d73673 move mutex classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	147 };
bb7513d73673 move mutex classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	148
13281 834f904a3dcb Add support for full asynchronous graphics toolkit running in a separate Michael Goffioul <michael.goffioul@gmail.com> parents: 11523 diff changeset	149
23057 bb7513d73673 move mutex classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	150 class
bb7513d73673 move mutex classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	151 OCTAVE_API
bb7513d73673 move mutex classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	152 thread
bb7513d73673 move mutex classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	153 {
bb7513d73673 move mutex classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	154 public:
bb7513d73673 move mutex classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	155
bb7513d73673 move mutex classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	156 static void init (void);
bb7513d73673 move mutex classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	157
bb7513d73673 move mutex classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	158 static bool is_thread (void);
bb7513d73673 move mutex classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	159 };
bb7513d73673 move mutex classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	160 }
bb7513d73673 move mutex classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23012 diff changeset	161
7934 5a156ab94dd2 Add octave_mutex class John W. Eaton <jwe@octave.org> parents: diff changeset	162 #endif

Mercurial > octave

annotate liboctave/util/oct-mutex.h @ 27919:1891570abac8