octave: libinterp/corefcn/event-queue.h annotate

annotate libinterp/corefcn/event-queue.h @ 23747:0b4d1575a2e2

move action_container and event_queue classes inside octave namespace * action-container.h (class action_container): Move inside octave namespace. * event-queue.h, event-queue.cc (class event_queue, (class event_queue_safe): Move inside octave namespace. Change all uses.

author	John W. Eaton <jwe@octave.org>
date	Fri, 07 Jul 2017 15:42:57 -0400
parents	092078913d54
children	194eb4bd202b

rev	line source
15396 1054ab58cd58 abstract unwind_protect John W. Eaton <jwe@octave.org> parents: diff changeset	1 /*
1054ab58cd58 abstract unwind_protect John W. Eaton <jwe@octave.org> parents: diff changeset	2
23219 3ac9f9ecfae5 maint: Update copyright dates. John W. Eaton <jwe@octave.org> parents: 23083 diff changeset	3 Copyright (C) 2012-2017 John W. Eaton
15396 1054ab58cd58 abstract unwind_protect John W. Eaton <jwe@octave.org> parents: diff changeset	4
1054ab58cd58 abstract unwind_protect John W. Eaton <jwe@octave.org> parents: diff changeset	5 This file is part of Octave.
1054ab58cd58 abstract unwind_protect John W. Eaton <jwe@octave.org> parents: diff changeset	6
1054ab58cd58 abstract unwind_protect John W. Eaton <jwe@octave.org> parents: diff changeset	7 Octave is free software; you can redistribute it and/or modify it
22755 3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22407 diff changeset	8 under the terms of the GNU General Public License as published by
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22407 diff changeset	9 the Free Software Foundation; either version 3 of the License, or
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22407 diff changeset	10 (at your option) any later version.
15396 1054ab58cd58 abstract unwind_protect John W. Eaton <jwe@octave.org> parents: diff changeset	11
22755 3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22407 diff changeset	12 Octave is distributed in the hope that it will be useful, but
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22407 diff changeset	13 WITHOUT ANY WARRANTY; without even the implied warranty of
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22407 diff changeset	14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22407 diff changeset	15 GNU General Public License for more details.
15396 1054ab58cd58 abstract unwind_protect John W. Eaton <jwe@octave.org> parents: diff changeset	16
1054ab58cd58 abstract unwind_protect John W. Eaton <jwe@octave.org> parents: diff changeset	17 You should have received a copy of the GNU General Public License
1054ab58cd58 abstract unwind_protect John W. Eaton <jwe@octave.org> parents: diff changeset	18 along with Octave; see the file COPYING. If not, see
1054ab58cd58 abstract unwind_protect John W. Eaton <jwe@octave.org> parents: diff changeset	19 <http://www.gnu.org/licenses/>.
1054ab58cd58 abstract unwind_protect John W. Eaton <jwe@octave.org> parents: diff changeset	20
1054ab58cd58 abstract unwind_protect John W. Eaton <jwe@octave.org> parents: diff changeset	21 */
1054ab58cd58 abstract unwind_protect John W. Eaton <jwe@octave.org> parents: diff changeset	22
20791 f7084eae3318 maint: Use Octave coding conventions for #if statements. Rik <rik@octave.org> parents: 20545 diff changeset	23 #if ! defined (octave_event_queue_h)
15396 1054ab58cd58 abstract unwind_protect John W. Eaton <jwe@octave.org> parents: diff changeset	24 #define octave_event_queue_h 1
1054ab58cd58 abstract unwind_protect John W. Eaton <jwe@octave.org> parents: diff changeset	25
21244 1473547f50f5 include octave-config.h in public header files John W. Eaton <jwe@octave.org> parents: 21141 diff changeset	26 #include "octave-config.h"
1473547f50f5 include octave-config.h in public header files John W. Eaton <jwe@octave.org> parents: 21141 diff changeset	27
15396 1054ab58cd58 abstract unwind_protect John W. Eaton <jwe@octave.org> parents: diff changeset	28 #include <queue>
1054ab58cd58 abstract unwind_protect John W. Eaton <jwe@octave.org> parents: diff changeset	29 #include <memory>
1054ab58cd58 abstract unwind_protect John W. Eaton <jwe@octave.org> parents: diff changeset	30
1054ab58cd58 abstract unwind_protect John W. Eaton <jwe@octave.org> parents: diff changeset	31 #include "action-container.h"
1054ab58cd58 abstract unwind_protect John W. Eaton <jwe@octave.org> parents: diff changeset	32
23747 0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	33 namespace octave
15396 1054ab58cd58 abstract unwind_protect John W. Eaton <jwe@octave.org> parents: diff changeset	34 {
23747 0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	35 class
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	36 event_queue : public action_container
15396 1054ab58cd58 abstract unwind_protect John W. Eaton <jwe@octave.org> parents: diff changeset	37 {
23747 0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	38 public:
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	39
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	40 event_queue (void) : fifo () { }
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	41
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	42 // No copying!
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	43
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	44 event_queue (const event_queue&) = delete;
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	45
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	46 event_queue& operator = (const event_queue&) = delete;
15396 1054ab58cd58 abstract unwind_protect John W. Eaton <jwe@octave.org> parents: diff changeset	47
23747 0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	48 // Destructor should not raise an exception, so all actions
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	49 // registered should be exception-safe. If you're not sure, see
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	50 // event_queue_safe.
15396 1054ab58cd58 abstract unwind_protect John W. Eaton <jwe@octave.org> parents: diff changeset	51
23747 0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	52 ~event_queue (void) { run (); }
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	53
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	54 void add (elem *new_elem)
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	55 {
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	56 fifo.push (new_elem);
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	57 }
15396 1054ab58cd58 abstract unwind_protect John W. Eaton <jwe@octave.org> parents: diff changeset	58
23747 0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	59 void run_first (void)
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	60 {
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	61 if (! empty ())
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	62 {
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	63 // No leak on exception!
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	64 std::unique_ptr<elem> ptr (fifo.front ());
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	65 fifo.pop ();
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	66 ptr->run ();
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	67 }
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	68 }
15396 1054ab58cd58 abstract unwind_protect John W. Eaton <jwe@octave.org> parents: diff changeset	69
23747 0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	70 void discard_first (void)
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	71 {
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	72 if (! empty ())
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	73 {
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	74 elem *ptr = fifo.front ();
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	75 fifo.pop ();
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	76 delete ptr;
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	77 }
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	78 }
15396 1054ab58cd58 abstract unwind_protect John W. Eaton <jwe@octave.org> parents: diff changeset	79
23747 0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	80 size_t size (void) const { return fifo.size (); }
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	81
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	82 protected:
15396 1054ab58cd58 abstract unwind_protect John W. Eaton <jwe@octave.org> parents: diff changeset	83
23747 0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	84 std::queue<elem *> fifo;
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	85 };
22869 f75d289645ec make deleted functions public John W. Eaton <jwe@octave.org> parents: 22865 diff changeset	86
23747 0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	87 // Like event_queue, but this one will guard against the
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	88 // possibility of seeing an exception (or interrupt) in the cleanup actions.
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	89 // Not that we can do much about it, but at least we won't crash.
22869 f75d289645ec make deleted functions public John W. Eaton <jwe@octave.org> parents: 22865 diff changeset	90
23747 0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	91 class
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	92 event_queue_safe : public event_queue
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	93 {
23747 0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	94 private:
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	95
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	96 void warn_unhandled_exception (void) const;
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	97
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	98 public:
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	99
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	100 event_queue_safe (void) : event_queue () { }
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	101
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	102 // No copying!
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	103
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	104 event_queue_safe (const event_queue_safe&) = delete;
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	105
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	106 event_queue_safe& operator = (const event_queue_safe&) = delete;
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	107
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	108 ~event_queue_safe (void)
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	109 {
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	110 while (! empty ())
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	111 {
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	112 try
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	113 {
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	114 run_first ();
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	115 }
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	116 catch (...) // Yes, the black hole. Remember we're in a dtor.
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	117 {
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	118 warn_unhandled_exception ();
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	119 }
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	120 }
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	121 }
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	122 };
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	123 }
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	124
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	125 #if defined (OCTAVE_USE_DEPRECATED_FUNCTIONS)
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	126
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	127 OCTAVE_DEPRECATED (4.4, "use 'octave::event_queue' instead")
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	128 typedef octave::event_queue event_queue;
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	129
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	130 OCTAVE_DEPRECATED (4.4, "use 'octave::event_queue_safe' instead")
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	131 typedef octave::event_queue_safe event_queue_safe;
15396 1054ab58cd58 abstract unwind_protect John W. Eaton <jwe@octave.org> parents: diff changeset	132
1054ab58cd58 abstract unwind_protect John W. Eaton <jwe@octave.org> parents: diff changeset	133 #endif
23747 0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	134
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	135 #endif

Mercurial > octave

annotate libinterp/corefcn/event-queue.h @ 23747:0b4d1575a2e2