Mercurial > octave
view libinterp/corefcn/event-manager.h @ 31605:e88a07dec498 stable
maint: Use macros to begin/end C++ namespaces.
* oct-conf-post-public.in.h: Define two macros (OCTAVE_BEGIN_NAMESPACE,
OCTAVE_END_NAMESPACE) that can be used to start/end a namespace.
* mk-opts.pl, build-env.h, build-env.in.cc, __betainc__.cc, __contourc__.cc,
__dsearchn__.cc, __eigs__.cc, __expint__.cc, __ftp__.cc, __gammainc__.cc,
__ichol__.cc, __ilu__.cc, __isprimelarge__.cc, __lin_interpn__.cc,
__magick_read__.cc, __pchip_deriv__.cc, __qp__.cc, amd.cc, auto-shlib.cc,
auto-shlib.h, balance.cc, base-text-renderer.cc, base-text-renderer.h,
besselj.cc, bitfcns.cc, bsxfun.cc, c-file-ptr-stream.cc, c-file-ptr-stream.h,
call-stack.cc, call-stack.h, ccolamd.cc, cellfun.cc, chol.cc, colamd.cc,
colloc.cc, conv2.cc, daspk.cc, dasrt.cc, dassl.cc, data.cc, data.h, debug.cc,
defaults.cc, defaults.h, defun-int.h, defun.cc, det.cc, dirfns.cc, display.cc,
display.h, dlmread.cc, dmperm.cc, dot.cc, dynamic-ld.cc, dynamic-ld.h, eig.cc,
ellipj.cc, environment.cc, environment.h, error.cc, error.h, errwarn.h,
event-manager.cc, event-manager.h, event-queue.cc, event-queue.h, fcn-info.cc,
fcn-info.h, fft.cc, fft2.cc, fftn.cc, file-io.cc, filter.cc, find.cc,
ft-text-renderer.cc, ft-text-renderer.h, gcd.cc, getgrent.cc, getpwent.cc,
getrusage.cc, givens.cc, gl-render.cc, gl-render.h, gl2ps-print.cc,
gl2ps-print.h, graphics-toolkit.cc, graphics-toolkit.h, graphics.cc,
graphics.in.h, gsvd.cc, gtk-manager.cc, gtk-manager.h, hash.cc, help.cc,
help.h, hess.cc, hex2num.cc, hook-fcn.cc, hook-fcn.h, input.cc, input.h,
interpreter-private.cc, interpreter-private.h, interpreter.cc, interpreter.h,
inv.cc, jsondecode.cc, jsonencode.cc, kron.cc, latex-text-renderer.cc,
latex-text-renderer.h, load-path.cc, load-path.h, load-save.cc, load-save.h,
lookup.cc, ls-ascii-helper.cc, ls-ascii-helper.h, ls-oct-text.cc, ls-utils.cc,
ls-utils.h, lsode.cc, lu.cc, mappers.cc, matrix_type.cc, max.cc, mex-private.h,
mex.cc, mgorth.cc, nproc.cc, oct-fstrm.cc, oct-fstrm.h, oct-hdf5-types.cc,
oct-hdf5-types.h, oct-hist.cc, oct-hist.h, oct-iostrm.cc, oct-iostrm.h,
oct-opengl.h, oct-prcstrm.cc, oct-prcstrm.h, oct-procbuf.cc, oct-procbuf.h,
oct-process.cc, oct-process.h, oct-stdstrm.h, oct-stream.cc, oct-stream.h,
oct-strstrm.cc, oct-strstrm.h, oct-tex-lexer.in.ll, oct-tex-parser.yy,
ordqz.cc, ordschur.cc, pager.cc, pager.h, pinv.cc, pow2.cc, pr-flt-fmt.cc,
pr-output.cc, procstream.cc, procstream.h, psi.cc, qr.cc, quad.cc, quadcc.cc,
qz.cc, rand.cc, rcond.cc, regexp.cc, schur.cc, settings.cc, settings.h,
sighandlers.cc, sighandlers.h, sparse-xdiv.cc, sparse-xdiv.h, sparse-xpow.cc,
sparse-xpow.h, sparse.cc, spparms.cc, sqrtm.cc, stack-frame.cc, stack-frame.h,
stream-euler.cc, strfind.cc, strfns.cc, sub2ind.cc, svd.cc, sylvester.cc,
symbfact.cc, syminfo.cc, syminfo.h, symrcm.cc, symrec.cc, symrec.h,
symscope.cc, symscope.h, symtab.cc, symtab.h, syscalls.cc, sysdep.cc, sysdep.h,
text-engine.cc, text-engine.h, text-renderer.cc, text-renderer.h, time.cc,
toplev.cc, tril.cc, tsearch.cc, typecast.cc, url-handle-manager.cc,
url-handle-manager.h, urlwrite.cc, utils.cc, utils.h, variables.cc,
variables.h, xdiv.cc, xdiv.h, xnorm.cc, xnorm.h, xpow.cc, xpow.h,
__delaunayn__.cc, __fltk_uigetfile__.cc, __glpk__.cc, __init_fltk__.cc,
__init_gnuplot__.cc, __ode15__.cc, __voronoi__.cc, audiodevinfo.cc,
audioread.cc, convhulln.cc, fftw.cc, gzip.cc, mk-build-env-features.sh,
mk-builtins.pl, cdef-class.cc, cdef-class.h, cdef-fwd.h, cdef-manager.cc,
cdef-manager.h, cdef-method.cc, cdef-method.h, cdef-object.cc, cdef-object.h,
cdef-package.cc, cdef-package.h, cdef-property.cc, cdef-property.h,
cdef-utils.cc, cdef-utils.h, ov-base.cc, ov-base.h, ov-bool-mat.cc,
ov-builtin.h, ov-cell.cc, ov-class.cc, ov-class.h, ov-classdef.cc,
ov-classdef.h, ov-complex.cc, ov-fcn-handle.cc, ov-fcn-handle.h, ov-fcn.h,
ov-java.cc, ov-java.h, ov-mex-fcn.h, ov-null-mat.cc, ov-oncleanup.cc,
ov-struct.cc, ov-typeinfo.cc, ov-typeinfo.h, ov-usr-fcn.cc, ov-usr-fcn.h,
ov.cc, ov.h, octave.cc, octave.h, mk-ops.sh, op-b-b.cc, op-b-bm.cc,
op-b-sbm.cc, op-bm-b.cc, op-bm-bm.cc, op-bm-sbm.cc, op-cdm-cdm.cc, op-cell.cc,
op-chm.cc, op-class.cc, op-cm-cm.cc, op-cm-cs.cc, op-cm-m.cc, op-cm-s.cc,
op-cm-scm.cc, op-cm-sm.cc, op-cs-cm.cc, op-cs-cs.cc, op-cs-m.cc, op-cs-s.cc,
op-cs-scm.cc, op-cs-sm.cc, op-dm-dm.cc, op-dm-scm.cc, op-dm-sm.cc,
op-dm-template.cc, op-dms-template.cc, op-fcdm-fcdm.cc, op-fcm-fcm.cc,
op-fcm-fcs.cc, op-fcm-fm.cc, op-fcm-fs.cc, op-fcn.cc, op-fcs-fcm.cc,
op-fcs-fcs.cc, op-fcs-fm.cc, op-fcs-fs.cc, op-fdm-fdm.cc, op-fm-fcm.cc,
op-fm-fcs.cc, op-fm-fm.cc, op-fm-fs.cc, op-fs-fcm.cc, op-fs-fcs.cc,
op-fs-fm.cc, op-fs-fs.cc, op-i16-i16.cc, op-i32-i32.cc, op-i64-i64.cc,
op-i8-i8.cc, op-int-concat.cc, op-m-cm.cc, op-m-cs.cc, op-m-m.cc, op-m-s.cc,
op-m-scm.cc, op-m-sm.cc, op-mi.cc, op-pm-pm.cc, op-pm-scm.cc, op-pm-sm.cc,
op-pm-template.cc, op-range.cc, op-s-cm.cc, op-s-cs.cc, op-s-m.cc, op-s-s.cc,
op-s-scm.cc, op-s-sm.cc, op-sbm-b.cc, op-sbm-bm.cc, op-sbm-sbm.cc,
op-scm-cm.cc, op-scm-cs.cc, op-scm-m.cc, op-scm-s.cc, op-scm-scm.cc,
op-scm-sm.cc, op-sm-cm.cc, op-sm-cs.cc, op-sm-m.cc, op-sm-s.cc, op-sm-scm.cc,
op-sm-sm.cc, op-str-m.cc, op-str-s.cc, op-str-str.cc, op-struct.cc,
op-ui16-ui16.cc, op-ui32-ui32.cc, op-ui64-ui64.cc, op-ui8-ui8.cc, ops.h,
anon-fcn-validator.cc, anon-fcn-validator.h, bp-table.cc, bp-table.h,
comment-list.cc, comment-list.h, filepos.h, lex.h, lex.ll, oct-lvalue.cc,
oct-lvalue.h, oct-parse.yy, parse.h, profiler.cc, profiler.h,
pt-anon-scopes.cc, pt-anon-scopes.h, pt-arg-list.cc, pt-arg-list.h,
pt-args-block.cc, pt-args-block.h, pt-array-list.cc, pt-array-list.h,
pt-assign.cc, pt-assign.h, pt-binop.cc, pt-binop.h, pt-bp.cc, pt-bp.h,
pt-cbinop.cc, pt-cbinop.h, pt-cell.cc, pt-cell.h, pt-check.cc, pt-check.h,
pt-classdef.cc, pt-classdef.h, pt-cmd.h, pt-colon.cc, pt-colon.h, pt-const.cc,
pt-const.h, pt-decl.cc, pt-decl.h, pt-eval.cc, pt-eval.h, pt-except.cc,
pt-except.h, pt-exp.cc, pt-exp.h, pt-fcn-handle.cc, pt-fcn-handle.h, pt-id.cc,
pt-id.h, pt-idx.cc, pt-idx.h, pt-jump.h, pt-loop.cc, pt-loop.h, pt-mat.cc,
pt-mat.h, pt-misc.cc, pt-misc.h, pt-pr-code.cc, pt-pr-code.h, pt-select.cc,
pt-select.h, pt-spmd.cc, pt-spmd.h, pt-stmt.cc, pt-stmt.h, pt-tm-const.cc,
pt-tm-const.h, pt-unop.cc, pt-unop.h, pt-vm-eval.cc, pt-walk.cc, pt-walk.h,
pt.cc, pt.h, token.cc, token.h, Range.cc, Range.h, idx-vector.cc, idx-vector.h,
range-fwd.h, CollocWt.cc, CollocWt.h, aepbalance.cc, aepbalance.h, chol.cc,
chol.h, gepbalance.cc, gepbalance.h, gsvd.cc, gsvd.h, hess.cc, hess.h,
lo-mappers.cc, lo-mappers.h, lo-specfun.cc, lo-specfun.h, lu.cc, lu.h,
oct-convn.cc, oct-convn.h, oct-fftw.cc, oct-fftw.h, oct-norm.cc, oct-norm.h,
oct-rand.cc, oct-rand.h, oct-spparms.cc, oct-spparms.h, qr.cc, qr.h, qrp.cc,
qrp.h, randgamma.cc, randgamma.h, randmtzig.cc, randmtzig.h, randpoisson.cc,
randpoisson.h, schur.cc, schur.h, sparse-chol.cc, sparse-chol.h, sparse-lu.cc,
sparse-lu.h, sparse-qr.cc, sparse-qr.h, svd.cc, svd.h, child-list.cc,
child-list.h, dir-ops.cc, dir-ops.h, file-ops.cc, file-ops.h, file-stat.cc,
file-stat.h, lo-sysdep.cc, lo-sysdep.h, lo-sysinfo.cc, lo-sysinfo.h,
mach-info.cc, mach-info.h, oct-env.cc, oct-env.h, oct-group.cc, oct-group.h,
oct-password.cc, oct-password.h, oct-syscalls.cc, oct-syscalls.h, oct-time.cc,
oct-time.h, oct-uname.cc, oct-uname.h, action-container.cc, action-container.h,
base-list.h, cmd-edit.cc, cmd-edit.h, cmd-hist.cc, cmd-hist.h, f77-fcn.h,
file-info.cc, file-info.h, lo-array-errwarn.cc, lo-array-errwarn.h, lo-hash.cc,
lo-hash.h, lo-ieee.h, lo-regexp.cc, lo-regexp.h, lo-utils.cc, lo-utils.h,
oct-base64.cc, oct-base64.h, oct-glob.cc, oct-glob.h, oct-inttypes.h,
oct-mutex.cc, oct-mutex.h, oct-refcount.h, oct-shlib.cc, oct-shlib.h,
oct-sparse.cc, oct-sparse.h, oct-string.h, octave-preserve-stream-state.h,
pathsearch.cc, pathsearch.h, quit.cc, quit.h, unwind-prot.cc, unwind-prot.h,
url-transfer.cc, url-transfer.h : Use new macros to begin/end C++ namespaces.
author | Rik <rik@octave.org> |
---|---|
date | Thu, 01 Dec 2022 14:23:45 -0800 |
parents | d81b39f1dec1 |
children | aac27ad79be6 |
line wrap: on
line source
//////////////////////////////////////////////////////////////////////// // // Copyright (C) 2011-2022 The Octave Project Developers // // See the file COPYRIGHT.md in the top-level directory of this // distribution or <https://octave.org/copyright/>. // // This file is part of Octave. // // Octave is free software: you can redistribute it and/or modify it // under the terms of the GNU General Public License as published by // the Free Software Foundation, either version 3 of the License, or // (at your option) any later version. // // Octave is distributed in the hope that it will be useful, but // WITHOUT ANY WARRANTY; without even the implied warranty of // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the // GNU General Public License for more details. // // You should have received a copy of the GNU General Public License // along with Octave; see the file COPYING. If not, see // <https://www.gnu.org/licenses/>. // //////////////////////////////////////////////////////////////////////// #if ! defined (octave_event_manager_h) #define octave_event_manager_h 1 #include "octave-config.h" #include <functional> #include <list> #include <memory> #include <stack> #include <string> #include "oct-mutex.h" #include "octave.h" #include "event-queue.h" #include "uint8NDArray.h" class octave_value; class string_vector; OCTAVE_BEGIN_NAMESPACE(octave) typedef std::function<void (void)> fcn_callback; typedef std::function<void (interpreter&)> meth_callback; class execution_exception; class symbol_info_list; // The methods in this class provide a way to pass signals to the GUI // thread. A GUI that wishes to act on these events should derive // from this class and perform actions in a thread-safe way. In // Octave's Qt-based GUI, for example, these functions are all // implemented as wrappers around Qt signals that trigger actions in // the GUI. The Qt signal/slot mechanism ensures that the actions are // properly queued for execution when the objects corresponding to the // signal and slot belong to different threads. // // These functions should not be called directly. Instead all // requests from the interpreter for GUI actions should be done // through the event_manager class. That class checks to ensure that // the GUI is connected and enabled before calling these virtual // functions. // FIXME: it would be nice if instead of requiring the GUI to derive // from this class, it could subscribe to individual events, possibly // multiple times. In that way, it would be more flexible and // decentralized, similar to the Qt signal/slot connection mechanism // and would allow the GUI to connect multiple signals to a single // action or multiple actions to a single signal. // FIXME: audit this list of functions and determine whether they are // all necessary and whether there might be better names for them. class OCTINTERP_API interpreter_events { public: interpreter_events (void) = default; interpreter_events (const interpreter_events&) = default; interpreter_events& operator = (const interpreter_events&) = default; virtual ~interpreter_events (void) = default; // Note: START_GUI and CLOSE_GUI currently only work with the new // experimental terminal widget. // Set GUI_APP to true when starting Octave as a gui application // (invoked with the --gui option) and false when starting the GUI // from the Octave prompt when Octave is already running as a // command line application. virtual void start_gui (bool /*gui_app*/ = false) { } virtual void close_gui (void) { } // Dialogs. virtual bool have_dialogs (void) const { return false; } typedef std::list<std::pair<std::string, std::string>> filter_list; virtual std::list<std::string> file_dialog (const filter_list& /*filter*/, const std::string& /*title*/, const std::string& /*filename*/, const std::string& /*dirname*/, const std::string& /*multimode*/) { return std::list<std::string> (); } virtual std::list<std::string> input_dialog (const std::list<std::string>& /*prompt*/, const std::string& /*title*/, const std::list<float>& /*nr*/, const std::list<float>& /*nc*/, const std::list<std::string>& /*defaults*/) { return std::list<std::string> (); } virtual std::pair<std::list<int>, int> list_dialog (const std::list<std::string>& /*list*/, const std::string& /*mode*/, int /*width*/, int /*height*/, const std::list<int>& /*initial_value*/, const std::string& /*name*/, const std::list<std::string>& /*prompt*/, const std::string& /*ok_string*/, const std::string& /*cancel_string*/) { return std::pair<std::list<int>, int> (); } virtual std::string question_dialog (const std::string& /*msg*/, const std::string& /*title*/, const std::string& /*btn1*/, const std::string& /*btn2*/, const std::string& /*btn3*/, const std::string& /*btndef*/) { return ""; } virtual void update_path_dialog (void) { } virtual void show_preferences (void) { } virtual void apply_preferences (void) { } virtual void show_terminal_window (void) { } virtual bool show_documentation (const std::string& /*file*/) { return false; } virtual void show_file_browser (void) { } virtual void show_command_history (void) { } virtual void show_workspace (void) { } virtual void show_community_news (int /*serial*/) { } virtual void show_release_notes (void) { } virtual bool edit_file (const std::string& /*file*/) { return false; } virtual void edit_variable (const std::string& /*name*/, const octave_value& /*val*/) { } // Other requests for user interaction, usually some kind of // confirmation before another action. Could these be reformulated // using the question_dialog action? virtual bool confirm_shutdown (void) { return true; } virtual bool prompt_new_edit_file (const std::string& /*file*/) { return false; } virtual int debug_cd_or_addpath_error (const std::string& /*file*/, const std::string& /*dir*/, bool /*addpath_option*/) { return -1; } // Requests for information normally stored in the GUI. virtual uint8NDArray get_named_icon (const std::string& /*icon_name*/) { return uint8NDArray (); } virtual std::string gui_preference (const std::string& /*key*/, const std::string& /*value*/) { return ""; } // Requests for GUI action that do not require user interaction. // These are different from other notifications in that they are not // associated with changes in the interpreter state (like a change // in the current working directory or command history). virtual bool copy_image_to_clipboard (const std::string& /*file*/) { return false; } virtual void focus_window (const std::string /*win_name*/) { } virtual void execute_command_in_terminal (const std::string& /*command*/) { } virtual void register_documentation (const std::string& /*file*/) { } virtual void unregister_documentation (const std::string& /*file*/) { } virtual void interpreter_output (const std::string& /*msg*/) { } virtual void display_exception (const execution_exception& ee, bool beep); virtual void gui_status_update (const std::string& /*feature*/, const std::string& /*status*/) { } virtual void update_gui_lexer (void) { } // Notifications of events in the interpreter that a GUI will // normally wish to respond to. virtual void directory_changed (const std::string& /*dir*/) { } virtual void file_remove (const std::string& /*old_nm*/, const std::string& /*new_nm*/) { } virtual void file_renamed (bool) { } virtual void set_workspace (bool /*top_level*/, bool /*debug*/, const symbol_info_list& /*syminfo*/, bool /*update_variable_editor*/) { } virtual void clear_workspace (void) { } virtual void update_prompt (const std::string& /*prompt*/) { } virtual void set_history (const string_vector& /*hist*/) { } virtual void append_history (const std::string& /*hist_entry*/) { } virtual void clear_history (void) { } virtual void pre_input_event (void) { } virtual void post_input_event (void) { } virtual void enter_debugger_event (const std::string& /*fcn_name*/, const std::string& /*fcn_file_name*/, int /*line*/) { } virtual void execute_in_debugger_event (const std::string& /*file*/, int /*line*/) { } virtual void exit_debugger_event (void) { } virtual void update_breakpoint (bool /*insert*/, const std::string& /*file*/, int /*line*/, const std::string& /*cond*/) { } virtual void interpreter_interrupted (void) { } }; //! Provides threadsafe access to octave. //! //! This class provides thread-safe communication between the //! interpreter and a GUI. class OCTINTERP_API event_manager { public: OCTINTERP_API event_manager (interpreter& interp); // No copying! event_manager (const event_manager&) = delete; event_manager& operator = (const event_manager&) = delete; virtual ~event_manager (void); // OBJ should be an object of a class that is derived from the base // class interpreter_events, or nullptr to disconnect and delete the // previous link. OCTINTERP_API void connect_link (const std::shared_ptr<interpreter_events>& obj); OCTINTERP_API bool enable (void); bool disable (void) { bool retval = m_link_enabled; m_link_enabled = false; return retval; } bool enabled (void) const { return m_link_enabled; } // Make the Qt actions available for others. This is a temporary // solution to allow Qt actions like opening the documentation // browser when the primary interpreter_events object is not the one // defined for the Qt GUI. void install_qt_event_handlers (const std::shared_ptr<interpreter_events>& obj) { m_qt_event_handlers = obj; } std::shared_ptr<interpreter_events> qt_event_handlers (void) const { return m_qt_event_handlers; } // If disable is TRUE, then no additional events will be processed // other than exit. OCTINTERP_API void process_events (bool disable = false); OCTINTERP_API void discard_events (void); // The post_event and post_exception functions provide a thread-safe // way for the GUI to queue interpreter functions for execution. // The queued functions are executed when the interpreter is // otherwise idle. void push_event_queue (void); void pop_event_queue (void); OCTINTERP_API void post_event (const fcn_callback& fcn); OCTINTERP_API void post_event (const meth_callback& meth); // The following functions correspond to the virtual fuunctions in // the interpreter_events class. They provide a way for the // interpreter to notify the GUI that some event has occurred // (directory or workspace changed, for example) or to request the // GUI to perform some action (display a dialog, for example). // Please keep this list of declarations in the same order as the // ones above in the interpreter_events class. // Note: START_GUI and CLOSE_GUI currently only work with the new // experimental terminal object. void start_gui (bool gui_app = false) { if (enabled ()) m_instance->start_gui (gui_app); } void close_gui (void) { if (enabled ()) m_instance->close_gui (); } // Dialogs bool have_dialogs (void) const { return m_qt_event_handlers && m_qt_event_handlers->have_dialogs (); } typedef std::list<std::pair<std::string, std::string>> filter_list; std::list<std::string> file_dialog (const filter_list& filter, const std::string& title, const std::string& filename, const std::string& dirname, const std::string& multimode) { return (enabled () && have_dialogs () ? m_instance->file_dialog (filter, title, filename, dirname, multimode) : std::list<std::string> ()); } std::list<std::string> input_dialog (const std::list<std::string>& prompt, const std::string& title, const std::list<float>& nr, const std::list<float>& nc, const std::list<std::string>& defaults) { return (enabled () && have_dialogs () ? m_instance->input_dialog (prompt, title, nr, nc, defaults) : std::list<std::string> ()); } std::pair<std::list<int>, int> list_dialog (const std::list<std::string>& list, const std::string& mode, int width, int height, const std::list<int>& initial_value, const std::string& name, const std::list<std::string>& prompt, const std::string& ok_string, const std::string& cancel_string) { return (enabled () && have_dialogs () ? m_instance->list_dialog (list, mode, width, height, initial_value, name, prompt, ok_string, cancel_string) : std::pair<std::list<int>, int> ()); } std::string question_dialog (const std::string& msg, const std::string& title, const std::string& btn1, const std::string& btn2, const std::string& btn3, const std::string& btndef) { return (enabled () && have_dialogs () ? m_instance->question_dialog (msg, title, btn1, btn2, btn3, btndef) : ""); } void update_path_dialog (void) { if (application::is_gui_running () && enabled ()) m_instance->update_path_dialog (); } bool show_preferences (void) { if (enabled ()) { m_instance->show_preferences (); return true; } else return false; } bool apply_preferences (void) { if (enabled ()) { m_instance->apply_preferences (); return true; } else return false; } void show_terminal_window (void) { if (enabled ()) m_instance->show_terminal_window (); } bool show_documentation (const std::string& file) { return enabled () ? m_instance->show_documentation (file) : false; } void show_file_browser (void) { if (enabled ()) m_instance->show_file_browser (); } void show_command_history (void) { if (enabled ()) m_instance->show_command_history (); } void show_workspace (void) { if (enabled ()) m_instance->show_workspace (); } void show_community_news (int serial = -1) { if (enabled ()) m_instance->show_community_news (serial); } void show_release_notes (void) { if (enabled ()) m_instance->show_release_notes (); } bool edit_file (const std::string& file) { return enabled () ? m_instance->edit_file (file) : false; } bool edit_variable (const std::string& name, const octave_value& val) { if (enabled ()) { m_instance->edit_variable (name, val); return true; } else return false; } bool confirm_shutdown (void) { bool retval = true; if (enabled ()) retval = m_instance->confirm_shutdown (); return retval; } bool prompt_new_edit_file (const std::string& file) { return enabled () ? m_instance->prompt_new_edit_file (file) : false; } int debug_cd_or_addpath_error (const std::string& file, const std::string& dir, bool addpath_option) { return (enabled () ? m_instance->debug_cd_or_addpath_error (file, dir, addpath_option) : 0); } uint8NDArray get_named_icon (const std::string& icon_name) { return (enabled () ? m_instance->get_named_icon (icon_name) : uint8NDArray ()); } std::string gui_preference (const std::string& key, const std::string& value) { return enabled () ? m_instance->gui_preference (key, value) : ""; } bool copy_image_to_clipboard (const std::string& file) { return enabled () ? m_instance->copy_image_to_clipboard (file) : false; } virtual void focus_window (const std::string win_name) { if (enabled ()) m_instance->focus_window (win_name); } // Preserves pending input. void execute_command_in_terminal (const std::string& command) { if (enabled ()) m_instance->execute_command_in_terminal (command); } bool register_documentation (const std::string& file) { if (enabled ()) { m_instance->register_documentation (file); return true; } else return false; } bool unregister_documentation (const std::string& file) { if (enabled ()) { m_instance->unregister_documentation (file); return true; } else return false; } bool interpreter_output (const std::string& msg) { if (enabled ()) { m_instance->interpreter_output (msg); return true; } else return false; } bool display_exception (const execution_exception& ee, bool beep = false) { if (enabled ()) { m_instance->display_exception (ee, beep); return true; } else return false; } bool gui_status_update (const std::string& feature, const std::string& status) { if (enabled ()) { m_instance->gui_status_update (feature, status); return true; } else return false; } bool update_gui_lexer (void) { if (enabled ()) { m_instance->update_gui_lexer (); return true; } else return false; } void directory_changed (const std::string& dir) { if (enabled ()) m_instance->directory_changed (dir); } // Methods for removing/renaming files which might be open in editor void file_remove (const std::string& old_name, const std::string& new_name) { if (application::is_gui_running () && enabled ()) m_instance->file_remove (old_name, new_name); } void file_renamed (bool load_new) { if (application::is_gui_running () && enabled ()) m_instance->file_renamed (load_new); } OCTINTERP_API void set_workspace (void); void set_workspace (bool top_level, const symbol_info_list& syminfo, bool update_variable_editor = true) { if (enabled ()) m_instance->set_workspace (top_level, m_debugging, syminfo, update_variable_editor); } void clear_workspace (void) { if (enabled ()) m_instance->clear_workspace (); } void update_prompt (const std::string& prompt) { if (enabled ()) m_instance->update_prompt (prompt); } OCTINTERP_API void set_history (void); void set_history (const string_vector& hist) { if (enabled ()) m_instance->set_history (hist); } void append_history (const std::string& hist_entry) { if (enabled ()) m_instance->append_history (hist_entry); } void clear_history (void) { if (enabled ()) m_instance->clear_history (); } void pre_input_event (void) { if (enabled ()) m_instance->pre_input_event (); } void post_input_event (void) { if (enabled ()) m_instance->post_input_event (); } void enter_debugger_event (const std::string& fcn_name, const std::string& fcn_file_name, int line) { if (enabled ()) { m_debugging = true; m_instance->enter_debugger_event (fcn_name, fcn_file_name, line); } } void execute_in_debugger_event (const std::string& file, int line) { if (enabled ()) m_instance->execute_in_debugger_event (file, line); } void exit_debugger_event (void) { if (enabled () && m_debugging) { m_debugging = false; m_instance->exit_debugger_event (); } } void update_breakpoint (bool insert, const std::string& file, int line, const std::string& cond = "") { if (enabled ()) m_instance->update_breakpoint (insert, file, line, cond); } void interpreter_interrupted (void) { if (enabled ()) m_instance->interpreter_interrupted (); } protected: // Semaphore to lock access to the event queue. mutex *m_event_queue_mutex; // Event Queue. We use a stack so that we can handle evaluation in // the debugger when we are executing in server mode. In server // mode, code is evaluated from inside the event queue. So when the // evaluator reaches a breakpoint, the queue is already locked and // executing an event function. We can't just add a new command to the // existing queue, so we need another one that can process new // events generated at the debug prompt. When execution continues // (dbcont or dbstep, for example) we pop the queue and return to // the previous point of execution. std::stack<std::shared_ptr <event_queue>> m_gui_event_queue; bool m_debugging; bool m_link_enabled; private: interpreter& m_interpreter; // Using a shared_ptr to manage the link_events object ensures that it // will be valid until it is no longer needed. std::shared_ptr<interpreter_events> m_instance; std::shared_ptr<interpreter_events> m_qt_event_handlers; }; OCTAVE_END_NAMESPACE(octave) #endif