octave-lyh: libgui/src/octave-adapter/octave-link.h annotate

annotate libgui/src/octave-adapter/octave-link.h @ 15204:359098ad343e

update copyright notices in libgui directory * documentation-dockwidget.cc, documentation-dockwidget.h, files-dockwidget.cc, files-dockwidget.h, history-dockwidget.cc, history-dockwidget.h, m-editor/file-editor-interface.h, m-editor/file-editor-tab.cc, m-editor/file-editor-tab.h, m-editor/file-editor.cc, m-editor/file-editor.h, m-editor/lexer-octave-gui.cc, m-editor/lexer-octave-gui.h, main-window.cc, main-window.h, octave-adapter/octave-event-listener.h, octave-adapter/octave-event-observer.h, octave-adapter/octave-event.cc, octave-adapter/octave-event.h, octave-adapter/octave-link.cc, octave-adapter/octave-link.h, octave-adapter/octave-main-thread.cc, octave-adapter/octave-main-thread.h, octave-gui.cc, octave-qt-event-listener.cc, octave-qt-event-listener.h, resource-manager.cc, resource-manager.h, settings-dialog.cc, settings-dialog.h, symbol-information.cc, symbol-information.h, terminal-dockwidget.cc, terminal-dockwidget.h, welcome-wizard.cc, welcome-wizard.h, workspace-model.cc, workspace-model.h, workspace-view.cc, workspace-view.h: Use copyright notice format that is consistent with other files in Octave.

author	John W. Eaton <jwe@octave.org>
date	Mon, 20 Aug 2012 14:02:08 -0400
parents	017f0b2e6933
children	eec0d1fcba4f

rev	line source
15204 359098ad343e update copyright notices in libgui directory John W. Eaton <jwe@octave.org> parents: 15196 diff changeset	1 /*
359098ad343e update copyright notices in libgui directory John W. Eaton <jwe@octave.org> parents: 15196 diff changeset	2
359098ad343e update copyright notices in libgui directory John W. Eaton <jwe@octave.org> parents: 15196 diff changeset	3 Copyright (C) 2011-2012 Jacob Dawid
359098ad343e update copyright notices in libgui directory John W. Eaton <jwe@octave.org> parents: 15196 diff changeset	4 Copyright (C) 2011-2012 John P. Swensen
359098ad343e update copyright notices in libgui directory John W. Eaton <jwe@octave.org> parents: 15196 diff changeset	5
359098ad343e update copyright notices in libgui directory John W. Eaton <jwe@octave.org> parents: 15196 diff changeset	6 This file is part of Octave.
359098ad343e update copyright notices in libgui directory John W. Eaton <jwe@octave.org> parents: 15196 diff changeset	7
359098ad343e update copyright notices in libgui directory John W. Eaton <jwe@octave.org> parents: 15196 diff changeset	8 Octave is free software; you can redistribute it and/or modify it
359098ad343e update copyright notices in libgui directory John W. Eaton <jwe@octave.org> parents: 15196 diff changeset	9 under the terms of the GNU General Public License as published by the
359098ad343e update copyright notices in libgui directory John W. Eaton <jwe@octave.org> parents: 15196 diff changeset	10 Free Software Foundation; either version 3 of the License, or (at your
359098ad343e update copyright notices in libgui directory John W. Eaton <jwe@octave.org> parents: 15196 diff changeset	11 option) any later version.
359098ad343e update copyright notices in libgui directory John W. Eaton <jwe@octave.org> parents: 15196 diff changeset	12
359098ad343e update copyright notices in libgui directory John W. Eaton <jwe@octave.org> parents: 15196 diff changeset	13 Octave is distributed in the hope that it will be useful, but WITHOUT
359098ad343e update copyright notices in libgui directory John W. Eaton <jwe@octave.org> parents: 15196 diff changeset	14 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
359098ad343e update copyright notices in libgui directory John W. Eaton <jwe@octave.org> parents: 15196 diff changeset	15 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
359098ad343e update copyright notices in libgui directory John W. Eaton <jwe@octave.org> parents: 15196 diff changeset	16 for more details.
359098ad343e update copyright notices in libgui directory John W. Eaton <jwe@octave.org> parents: 15196 diff changeset	17
359098ad343e update copyright notices in libgui directory John W. Eaton <jwe@octave.org> parents: 15196 diff changeset	18 You should have received a copy of the GNU General Public License
359098ad343e update copyright notices in libgui directory John W. Eaton <jwe@octave.org> parents: 15196 diff changeset	19 along with Octave; see the file COPYING. If not, see
359098ad343e update copyright notices in libgui directory John W. Eaton <jwe@octave.org> parents: 15196 diff changeset	20 <http://www.gnu.org/licenses/>.
359098ad343e update copyright notices in libgui directory John W. Eaton <jwe@octave.org> parents: 15196 diff changeset	21
359098ad343e update copyright notices in libgui directory John W. Eaton <jwe@octave.org> parents: 15196 diff changeset	22 */
13501 86d6c3b90ad7 Added new gui files. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	23
86d6c3b90ad7 Added new gui files. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	24 #ifndef OCTAVELINK_H
86d6c3b90ad7 Added new gui files. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	25 #define OCTAVELINK_H
86d6c3b90ad7 Added new gui files. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	26
15155 9e62d5a3a45e partial cleanup of include files in gui sources John W. Eaton <jwe@octave.org> parents: 15080 diff changeset	27 #include <queue>
9e62d5a3a45e partial cleanup of include files in gui sources John W. Eaton <jwe@octave.org> parents: 15080 diff changeset	28 #include <string>
13501 86d6c3b90ad7 Added new gui files. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	29
15155 9e62d5a3a45e partial cleanup of include files in gui sources John W. Eaton <jwe@octave.org> parents: 15080 diff changeset	30 class octave_mutex;
13501 86d6c3b90ad7 Added new gui files. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	31
14707 674740c44c09 Changed various files to matche file naming conventions. Jacob Dawid <jacob.dawid@googlemail.com> parents: 14703 diff changeset	32 #include "octave-main-thread.h"
14714 4ff6c21c18c4 Solved crash on close by ignoring close event and instead executing exit in the terminal. Jacob Dawid <jacob.dawid@googlemail.com> parents: 14713 diff changeset	33 #include "octave-event.h"
14718 3df7ef0080c7 Added event based processing and implement exit and change directory event. Jacob Dawid <jacob.dawid@googlemail.com> parents: 14714 diff changeset	34 #include "octave-event-observer.h"
14719 89c64340e9ab Extended event based communication model. Jacob Dawid <jacob.dawid@googlemail.com> parents: 14718 diff changeset	35 #include "octave-event-listener.h"
13541 b48ac9ad8de0 Highly improved separation of model and view classes. Jacob Dawid <jacob.dawid@googlemail.com> parents: 13522 diff changeset	36
13501 86d6c3b90ad7 Added new gui files. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	37 /**
86d6c3b90ad7 Added new gui files. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	38 * \class OctaveLink
14713 565ddd85565e Added comments for the octave-adapter module. Jacob Dawid <jacob.dawid@googlemail.com> parents: 14712 diff changeset	39 * \brief Provides threadsafe access to octave.
565ddd85565e Added comments for the octave-adapter module. Jacob Dawid <jacob.dawid@googlemail.com> parents: 14712 diff changeset	40 * \author Jacob Dawid
565ddd85565e Added comments for the octave-adapter module. Jacob Dawid <jacob.dawid@googlemail.com> parents: 14712 diff changeset	41 * This class is a wrapper around octave and provides threadsafety by
565ddd85565e Added comments for the octave-adapter module. Jacob Dawid <jacob.dawid@googlemail.com> parents: 14712 diff changeset	42 * buffering access operations to octave and executing them in the readline
14719 89c64340e9ab Extended event based communication model. Jacob Dawid <jacob.dawid@googlemail.com> parents: 14718 diff changeset	43 * event hook, which lives in the octave thread.
13501 86d6c3b90ad7 Added new gui files. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	44 */
14719 89c64340e9ab Extended event based communication model. Jacob Dawid <jacob.dawid@googlemail.com> parents: 14718 diff changeset	45 class octave_link : public octave_event_observer
13501 86d6c3b90ad7 Added new gui files. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	46 {
86d6c3b90ad7 Added new gui files. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	47 public:
14713 565ddd85565e Added comments for the octave-adapter module. Jacob Dawid <jacob.dawid@googlemail.com> parents: 14712 diff changeset	48 /** Provides a way to access the unique octave_link object. */
14721 ec76264adca9 Removed last bits of Qt from octave_link. Jacob Dawid <jacob.dawid@googlemail.com> parents: 14720 diff changeset	49 static octave_link * instance () { return &_singleton; }
14713 565ddd85565e Added comments for the octave-adapter module. Jacob Dawid <jacob.dawid@googlemail.com> parents: 14712 diff changeset	50
565ddd85565e Added comments for the octave-adapter module. Jacob Dawid <jacob.dawid@googlemail.com> parents: 14712 diff changeset	51 /** Starts octave. */
565ddd85565e Added comments for the octave-adapter module. Jacob Dawid <jacob.dawid@googlemail.com> parents: 14712 diff changeset	52 void launch_octave ();
14719 89c64340e9ab Extended event based communication model. Jacob Dawid <jacob.dawid@googlemail.com> parents: 14718 diff changeset	53 void register_event_listener (octave_event_listener *oel);
89c64340e9ab Extended event based communication model. Jacob Dawid <jacob.dawid@googlemail.com> parents: 14718 diff changeset	54
89c64340e9ab Extended event based communication model. Jacob Dawid <jacob.dawid@googlemail.com> parents: 14718 diff changeset	55 void generate_events ();
14718 3df7ef0080c7 Added event based processing and implement exit and change directory event. Jacob Dawid <jacob.dawid@googlemail.com> parents: 14714 diff changeset	56 void process_events ();
3df7ef0080c7 Added event based processing and implement exit and change directory event. Jacob Dawid <jacob.dawid@googlemail.com> parents: 14714 diff changeset	57 void post_event (octave_event *e);
14720 cecc7da96e2a Added update events for the command history model and workspace model. Jacob Dawid <jacob.dawid@googlemail.com> parents: 14719 diff changeset	58 void event_accepted (octave_event *e);
cecc7da96e2a Added update events for the command history model and workspace model. Jacob Dawid <jacob.dawid@googlemail.com> parents: 14719 diff changeset	59 void event_reject (octave_event *e);
14718 3df7ef0080c7 Added event based processing and implement exit and change directory event. Jacob Dawid <jacob.dawid@googlemail.com> parents: 14714 diff changeset	60
14721 ec76264adca9 Removed last bits of Qt from octave_link. Jacob Dawid <jacob.dawid@googlemail.com> parents: 14720 diff changeset	61 void about_to_exit ();
14754 626a8ff2fe8c The GUI now shows performance information in the status bar of the GUI (ie. how much overhead it causes in the octave thread compares to the terminal version). Jacob Dawid <jacob.dawid@googlemail.com> parents: 14726 diff changeset	62
626a8ff2fe8c The GUI now shows performance information in the status bar of the GUI (ie. how much overhead it causes in the octave thread compares to the terminal version). Jacob Dawid <jacob.dawid@googlemail.com> parents: 14726 diff changeset	63 void entered_readline_hook ();
626a8ff2fe8c The GUI now shows performance information in the status bar of the GUI (ie. how much overhead it causes in the octave thread compares to the terminal version). Jacob Dawid <jacob.dawid@googlemail.com> parents: 14726 diff changeset	64 void finished_readline_hook ();
626a8ff2fe8c The GUI now shows performance information in the status bar of the GUI (ie. how much overhead it causes in the octave thread compares to the terminal version). Jacob Dawid <jacob.dawid@googlemail.com> parents: 14726 diff changeset	65
14804 a565c560e654 Replaced a lot of terminal interaction with events: Clearing, loading and saving workspace, running a file. Default location for saving a new file is now the current working directory. Fixed bad settings with a fresh installation of the GUI by providing a file with default settings and installing it when appropriate. Jacob Dawid <jacob.dawid@googlemail.com> parents: 14754 diff changeset	66 std::string get_last_working_directory ();
a565c560e654 Replaced a lot of terminal interaction with events: Clearing, loading and saving workspace, running a file. Default location for saving a new file is now the current working directory. Fixed bad settings with a fresh installation of the GUI by providing a file with default settings and installing it when appropriate. Jacob Dawid <jacob.dawid@googlemail.com> parents: 14754 diff changeset	67
13501 86d6c3b90ad7 Added new gui files. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	68 private:
14713 565ddd85565e Added comments for the octave-adapter module. Jacob Dawid <jacob.dawid@googlemail.com> parents: 14712 diff changeset	69 /** Singleton. */
14709 f50591409306 Started to rename class names and methods from camel case to underscore- Jacob Dawid <jacob.dawid@googlemail.com> parents: 14707 diff changeset	70 octave_link ();
f50591409306 Started to rename class names and methods from camel case to underscore- Jacob Dawid <jacob.dawid@googlemail.com> parents: 14707 diff changeset	71 ~octave_link ();
13501 86d6c3b90ad7 Added new gui files. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	72
14719 89c64340e9ab Extended event based communication model. Jacob Dawid <jacob.dawid@googlemail.com> parents: 14718 diff changeset	73 octave_event_listener *_octave_event_listener;
89c64340e9ab Extended event based communication model. Jacob Dawid <jacob.dawid@googlemail.com> parents: 14718 diff changeset	74
14713 565ddd85565e Added comments for the octave-adapter module. Jacob Dawid <jacob.dawid@googlemail.com> parents: 14712 diff changeset	75 /** Thread running octave_main. */
14712 5cb54cca8a06 Completion of code reformatting. Jacob Dawid <jacob.dawid@googlemail.com> parents: 14709 diff changeset	76 octave_main_thread *_octave_main_thread;
14713 565ddd85565e Added comments for the octave-adapter module. Jacob Dawid <jacob.dawid@googlemail.com> parents: 14712 diff changeset	77
14718 3df7ef0080c7 Added event based processing and implement exit and change directory event. Jacob Dawid <jacob.dawid@googlemail.com> parents: 14714 diff changeset	78 /** Semaphore to lock access to the event queue. */
14721 ec76264adca9 Removed last bits of Qt from octave_link. Jacob Dawid <jacob.dawid@googlemail.com> parents: 14720 diff changeset	79 octave_mutex *_event_queue_mutex;
14718 3df7ef0080c7 Added event based processing and implement exit and change directory event. Jacob Dawid <jacob.dawid@googlemail.com> parents: 14714 diff changeset	80
3df7ef0080c7 Added event based processing and implement exit and change directory event. Jacob Dawid <jacob.dawid@googlemail.com> parents: 14714 diff changeset	81 /** Buffer for queueing events until they will be processed. */
14719 89c64340e9ab Extended event based communication model. Jacob Dawid <jacob.dawid@googlemail.com> parents: 14718 diff changeset	82 std::queue <octave_event *> _event_queue;
14718 3df7ef0080c7 Added event based processing and implement exit and change directory event. Jacob Dawid <jacob.dawid@googlemail.com> parents: 14714 diff changeset	83
14713 565ddd85565e Added comments for the octave-adapter module. Jacob Dawid <jacob.dawid@googlemail.com> parents: 14712 diff changeset	84 /** Stores the last known current working directory of octave. */
14719 89c64340e9ab Extended event based communication model. Jacob Dawid <jacob.dawid@googlemail.com> parents: 14718 diff changeset	85 std::string _last_working_directory;
14726 e94a54ee0f46 Added debug events, debug mode detection and fixed compiling error. Jacob Dawid <jacob.dawid@googlemail.com> parents: 14722 diff changeset	86 bool _debugging_mode_active;
14713 565ddd85565e Added comments for the octave-adapter module. Jacob Dawid <jacob.dawid@googlemail.com> parents: 14712 diff changeset	87
14754 626a8ff2fe8c The GUI now shows performance information in the status bar of the GUI (ie. how much overhead it causes in the octave thread compares to the terminal version). Jacob Dawid <jacob.dawid@googlemail.com> parents: 14726 diff changeset	88 /** Semaphore to lock access to the performance information. */
626a8ff2fe8c The GUI now shows performance information in the status bar of the GUI (ie. how much overhead it causes in the octave thread compares to the terminal version). Jacob Dawid <jacob.dawid@googlemail.com> parents: 14726 diff changeset	89 octave_mutex *_performance_information_mutex;
626a8ff2fe8c The GUI now shows performance information in the status bar of the GUI (ie. how much overhead it causes in the octave thread compares to the terminal version). Jacob Dawid <jacob.dawid@googlemail.com> parents: 14726 diff changeset	90
14713 565ddd85565e Added comments for the octave-adapter module. Jacob Dawid <jacob.dawid@googlemail.com> parents: 14712 diff changeset	91 /** Unique instance. Singelton! */
14712 5cb54cca8a06 Completion of code reformatting. Jacob Dawid <jacob.dawid@googlemail.com> parents: 14709 diff changeset	92 static octave_link _singleton;
13501 86d6c3b90ad7 Added new gui files. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	93 };
86d6c3b90ad7 Added new gui files. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	94 #endif // OCTAVELINK_H

Mercurial > hg > octave-lyh

annotate libgui/src/octave-adapter/octave-link.h @ 15204:359098ad343e