octave: gui/src/octave-adapter/octave-link.h annotate

annotate gui/src/octave-adapter/octave-link.h @ 15155:9e62d5a3a45e gui

partial cleanup of include files in gui sources * symbol-information.cc, octave-adapter/octave-event.cc: New files. * documentation-dockwidget.h, history-dockwidget.cc, m-editor/file-editor.h, octave-event.cc, octave-event.h, octave-link.cc, octave-link.h, octave-main-thread.cc, octave-gui.cc, symbol-information.cc, symbol-information.h, workspace-model.cc: Avoid including unnecssary header files.

author	John W. Eaton <jwe@octave.org>
date	Sat, 11 Aug 2012 11:02:12 -0400
parents	4c4f2fb07a50
children

rev	line source
13674 c0e66d6e3dc8 Updated license headers and moved to AGPLv3. Jacob Dawid <jacob.dawid@googlemail.com> parents: 13595 diff changeset	1 /* OctaveGUI - A graphical user interface for Octave
c0e66d6e3dc8 Updated license headers and moved to AGPLv3. Jacob Dawid <jacob.dawid@googlemail.com> parents: 13595 diff changeset	2 * Copyright (C) 2011 John P. Swensen, Jacob Dawid (jacob.dawid@googlemail.com)
13501 86d6c3b90ad7 Added new gui files. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	3 *
13674 c0e66d6e3dc8 Updated license headers and moved to AGPLv3. Jacob Dawid <jacob.dawid@googlemail.com> parents: 13595 diff changeset	4 * This program is free software: you can redistribute it and/or modify
14290 faece6b2ab90 Corrected license headers in all files to GPL. Jacob Dawid <jacob.dawid@googlemail.com> parents: 13683 diff changeset	5 * it under the terms of the GNU General Public License as
13674 c0e66d6e3dc8 Updated license headers and moved to AGPLv3. Jacob Dawid <jacob.dawid@googlemail.com> parents: 13595 diff changeset	6 * published by the Free Software Foundation, either version 3 of the
c0e66d6e3dc8 Updated license headers and moved to AGPLv3. Jacob Dawid <jacob.dawid@googlemail.com> parents: 13595 diff changeset	7 * License, or (at your option) any later version.
13501 86d6c3b90ad7 Added new gui files. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	8 *
13674 c0e66d6e3dc8 Updated license headers and moved to AGPLv3. Jacob Dawid <jacob.dawid@googlemail.com> parents: 13595 diff changeset	9 * This program is distributed in the hope that it will be useful,
c0e66d6e3dc8 Updated license headers and moved to AGPLv3. Jacob Dawid <jacob.dawid@googlemail.com> parents: 13595 diff changeset	10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
c0e66d6e3dc8 Updated license headers and moved to AGPLv3. Jacob Dawid <jacob.dawid@googlemail.com> parents: 13595 diff changeset	11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14290 faece6b2ab90 Corrected license headers in all files to GPL. Jacob Dawid <jacob.dawid@googlemail.com> parents: 13683 diff changeset	12 * GNU General Public License for more details.
13501 86d6c3b90ad7 Added new gui files. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	13 *
14290 faece6b2ab90 Corrected license headers in all files to GPL. Jacob Dawid <jacob.dawid@googlemail.com> parents: 13683 diff changeset	14 * You should have received a copy of the GNU General Public License
13674 c0e66d6e3dc8 Updated license headers and moved to AGPLv3. Jacob Dawid <jacob.dawid@googlemail.com> parents: 13595 diff changeset	15 * along with this program. If not, see <http://www.gnu.org/licenses/>.
c0e66d6e3dc8 Updated license headers and moved to AGPLv3. Jacob Dawid <jacob.dawid@googlemail.com> parents: 13595 diff changeset	16 */
13501 86d6c3b90ad7 Added new gui files. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	17
86d6c3b90ad7 Added new gui files. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	18 #ifndef OCTAVELINK_H
86d6c3b90ad7 Added new gui files. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	19 #define OCTAVELINK_H
86d6c3b90ad7 Added new gui files. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	20
15155 9e62d5a3a45e partial cleanup of include files in gui sources John W. Eaton <jwe@octave.org> parents: 15080 diff changeset	21 #include <queue>
9e62d5a3a45e partial cleanup of include files in gui sources John W. Eaton <jwe@octave.org> parents: 15080 diff changeset	22 #include <string>
13501 86d6c3b90ad7 Added new gui files. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	23
15155 9e62d5a3a45e partial cleanup of include files in gui sources John W. Eaton <jwe@octave.org> parents: 15080 diff changeset	24 class octave_mutex;
13501 86d6c3b90ad7 Added new gui files. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	25
14707 674740c44c09 Changed various files to matche file naming conventions. Jacob Dawid <jacob.dawid@googlemail.com> parents: 14703 diff changeset	26 #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	27 #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	28 #include "octave-event-observer.h"
14719 89c64340e9ab Extended event based communication model. Jacob Dawid <jacob.dawid@googlemail.com> parents: 14718 diff changeset	29 #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	30
13501 86d6c3b90ad7 Added new gui files. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	31 /**
86d6c3b90ad7 Added new gui files. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	32 * \class OctaveLink
14713 565ddd85565e Added comments for the octave-adapter module. Jacob Dawid <jacob.dawid@googlemail.com> parents: 14712 diff changeset	33 * \brief Provides threadsafe access to octave.
565ddd85565e Added comments for the octave-adapter module. Jacob Dawid <jacob.dawid@googlemail.com> parents: 14712 diff changeset	34 * \author Jacob Dawid
565ddd85565e Added comments for the octave-adapter module. Jacob Dawid <jacob.dawid@googlemail.com> parents: 14712 diff changeset	35 * 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	36 * 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	37 * event hook, which lives in the octave thread.
13501 86d6c3b90ad7 Added new gui files. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	38 */
14719 89c64340e9ab Extended event based communication model. Jacob Dawid <jacob.dawid@googlemail.com> parents: 14718 diff changeset	39 class octave_link : public octave_event_observer
13501 86d6c3b90ad7 Added new gui files. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	40 {
86d6c3b90ad7 Added new gui files. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	41 public:
14713 565ddd85565e Added comments for the octave-adapter module. Jacob Dawid <jacob.dawid@googlemail.com> parents: 14712 diff changeset	42 /** 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	43 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	44
565ddd85565e Added comments for the octave-adapter module. Jacob Dawid <jacob.dawid@googlemail.com> parents: 14712 diff changeset	45 /** Starts octave. */
565ddd85565e Added comments for the octave-adapter module. Jacob Dawid <jacob.dawid@googlemail.com> parents: 14712 diff changeset	46 void launch_octave ();
14719 89c64340e9ab Extended event based communication model. Jacob Dawid <jacob.dawid@googlemail.com> parents: 14718 diff changeset	47 void register_event_listener (octave_event_listener *oel);
89c64340e9ab Extended event based communication model. Jacob Dawid <jacob.dawid@googlemail.com> parents: 14718 diff changeset	48
89c64340e9ab Extended event based communication model. Jacob Dawid <jacob.dawid@googlemail.com> parents: 14718 diff changeset	49 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	50 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	51 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	52 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	53 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	54
14721 ec76264adca9 Removed last bits of Qt from octave_link. Jacob Dawid <jacob.dawid@googlemail.com> parents: 14720 diff changeset	55 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	56
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	57 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	58 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	59
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	60 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	61
13501 86d6c3b90ad7 Added new gui files. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	62 private:
14713 565ddd85565e Added comments for the octave-adapter module. Jacob Dawid <jacob.dawid@googlemail.com> parents: 14712 diff changeset	63 /** 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	64 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	65 ~octave_link ();
13501 86d6c3b90ad7 Added new gui files. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	66
14719 89c64340e9ab Extended event based communication model. Jacob Dawid <jacob.dawid@googlemail.com> parents: 14718 diff changeset	67 octave_event_listener *_octave_event_listener;
89c64340e9ab Extended event based communication model. Jacob Dawid <jacob.dawid@googlemail.com> parents: 14718 diff changeset	68
14713 565ddd85565e Added comments for the octave-adapter module. Jacob Dawid <jacob.dawid@googlemail.com> parents: 14712 diff changeset	69 /** Thread running octave_main. */
14712 5cb54cca8a06 Completion of code reformatting. Jacob Dawid <jacob.dawid@googlemail.com> parents: 14709 diff changeset	70 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	71
14718 3df7ef0080c7 Added event based processing and implement exit and change directory event. Jacob Dawid <jacob.dawid@googlemail.com> parents: 14714 diff changeset	72 /** 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	73 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	74
3df7ef0080c7 Added event based processing and implement exit and change directory event. Jacob Dawid <jacob.dawid@googlemail.com> parents: 14714 diff changeset	75 /** 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	76 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	77
14713 565ddd85565e Added comments for the octave-adapter module. Jacob Dawid <jacob.dawid@googlemail.com> parents: 14712 diff changeset	78 /** 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	79 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	80 bool _debugging_mode_active;
14713 565ddd85565e Added comments for the octave-adapter module. Jacob Dawid <jacob.dawid@googlemail.com> parents: 14712 diff changeset	81
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	82 /** 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	83 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	84
14713 565ddd85565e Added comments for the octave-adapter module. Jacob Dawid <jacob.dawid@googlemail.com> parents: 14712 diff changeset	85 /** Unique instance. Singelton! */
14712 5cb54cca8a06 Completion of code reformatting. Jacob Dawid <jacob.dawid@googlemail.com> parents: 14709 diff changeset	86 static octave_link _singleton;
13501 86d6c3b90ad7 Added new gui files. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	87 };
86d6c3b90ad7 Added new gui files. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	88 #endif // OCTAVELINK_H

Mercurial > octave

annotate gui/src/octave-adapter/octave-link.h @ 15155:9e62d5a3a45e gui