Mercurial > octave
view libinterp/corefcn/octave-link.h @ 22407:34ce5be04942
maint: Style check C++ code in libinterp/.
* build-env.h, build-env.in.cc, builtins.h, Cell.cc, Cell.h, __contourc__.cc,
__dispatch__.cc, __dsearchn__.cc, __ilu__.cc, __lin_interpn__.cc, __luinc__.cc,
__magick_read__.cc, __pchip_deriv__.cc, __qp__.cc, balance.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, cdisplay.c, cdisplay.h,
cellfun.cc, coct-hdf5-types.c, comment-list.cc, comment-list.h, conv2.cc,
daspk.cc, dasrt.cc, dassl.cc, data.cc, data.h, debug.cc, debug.h, defaults.cc,
defaults.in.h, defun-dld.h, defun-int.h, defun.h, det.cc, dirfns.cc, dirfns.h,
display.cc, display.h, dlmread.cc, dynamic-ld.cc, dynamic-ld.h, eig.cc,
error.cc, error.h, errwarn.h, event-queue.cc, event-queue.h, fft.cc, fft2.cc,
fftn.cc, file-io.cc, file-io.h, filter.cc, find.cc, ft-text-renderer.cc,
ft-text-renderer.h, gammainc.cc, gcd.cc, getgrent.cc, getpwent.cc, givens.cc,
gl-render.cc, gl-render.h, gl2ps-print.cc, gl2ps-print.h, graphics.cc,
graphics.in.h, gripes.h, gsvd.cc, hash.cc, help.cc, help.h, hess.cc,
hex2num.cc, hook-fcn.cc, hook-fcn.h, input.cc, input.h, interpreter.cc,
interpreter.h, inv.cc, jit-ir.cc, jit-ir.h, jit-typeinfo.cc, jit-typeinfo.h,
jit-util.cc, jit-util.h, kron.cc, load-path.cc, load-path.h, load-save.cc,
load-save.h, lookup.cc, ls-ascii-helper.cc, ls-ascii-helper.h, ls-hdf5.cc,
ls-hdf5.h, ls-mat-ascii.cc, ls-mat-ascii.h, ls-mat4.cc, ls-mat4.h, ls-mat5.h,
ls-oct-binary.cc, ls-oct-binary.h, ls-oct-text.cc, ls-oct-text.h, ls-utils.cc,
ls-utils.h, lsode.cc, lu.cc, matrix_type.cc, max.cc, mex.cc, mex.h, mexproto.h,
mgorth.cc, mxarray.in.h, nproc.cc, oct-errno.h, oct-errno.in.cc, oct-fstrm.cc,
oct-fstrm.h, oct-handle.h, oct-hdf5-types.cc, oct-hdf5-types.h, oct-hdf5.h,
oct-hist.cc, oct-hist.h, oct-iostrm.cc, oct-iostrm.h, oct-lvalue.cc,
oct-lvalue.h, oct-map.h, oct-obj.h, oct-opengl.h, oct-prcstrm.cc,
oct-prcstrm.h, oct-procbuf.cc, oct-procbuf.h, oct-stdstrm.h, oct-stream.cc,
oct-stream.h, oct-strstrm.cc, oct-strstrm.h, oct.h, octave-default-image.h,
octave-link.h, octave-preserve-stream-state.h, ordschur.cc, pager.cc, pager.h,
pinv.cc, pr-output.cc, pr-output.h, procstream.cc, procstream.h, profiler.h,
psi.cc, pt-jit.cc, pt-jit.h, quad.cc, quadcc.cc, qz.cc, rand.cc, rcond.cc,
regexp.cc, schur.cc, sighandlers.cc, sighandlers.h, sparse-xdiv.cc,
sparse-xdiv.h, sparse-xpow.cc, sparse-xpow.h, sparse.cc, spparms.cc, sqrtm.cc,
str2double.cc, strfind.cc, strfns.cc, sub2ind.cc, svd.cc, sylvester.cc,
symtab.cc, symtab.h, syscalls.cc, sysdep.cc, sysdep.h, text-renderer.cc,
text-renderer.h, time.cc, toplev.cc, toplev.h, tril.cc, tsearch.cc, txt-eng.cc,
txt-eng.h, typecast.cc, urlwrite.cc, utils.cc, utils.h, variables.cc,
variables.h, workspace-element.h, xdiv.cc, xdiv.h, xnorm.cc, xnorm.h, xpow.cc,
xpow.h, zfstream.cc, zfstream.h, deprecated-config.h, __delaunayn__.cc,
__eigs__.cc, __fltk_uigetfile__.cc, __glpk__.cc, __init_fltk__.cc,
__init_gnuplot__.cc, __osmesa_print__.cc, __voronoi__.cc, amd.cc,
audiodevinfo.cc, audioread.cc, ccolamd.cc, chol.cc, colamd.cc, convhulln.cc,
dmperm.cc, fftw.cc, gzip.cc, oct-qhull.h, qr.cc, symbfact.cc, symrcm.cc,
liboctinterp-build-info.h, liboctinterp-build-info.in.cc, ov-base-diag.h,
ov-base-int.cc, ov-base-int.h, ov-base-mat.cc, ov-base-mat.h, ov-base-scalar.h,
ov-base-sparse.cc, ov-base-sparse.h, ov-base.cc, ov-base.h, ov-bool-mat.cc,
ov-bool-mat.h, ov-bool-sparse.cc, ov-bool-sparse.h, ov-bool.cc, ov-bool.h,
ov-builtin.cc, ov-builtin.h, ov-cell.cc, ov-cell.h, ov-ch-mat.cc, ov-ch-mat.h,
ov-class.cc, ov-class.h, ov-classdef.cc, ov-classdef.h, ov-colon.cc,
ov-colon.h, ov-complex.cc, ov-complex.h, ov-cs-list.h, ov-cx-diag.cc,
ov-cx-diag.h, ov-cx-mat.cc, ov-cx-mat.h, ov-cx-sparse.cc, ov-cx-sparse.h,
ov-dld-fcn.cc, ov-dld-fcn.h, ov-fcn-handle.cc, ov-fcn-handle.h,
ov-fcn-inline.cc, ov-fcn-inline.h, ov-fcn.cc, ov-fcn.h, ov-float.cc,
ov-float.h, ov-flt-complex.cc, ov-flt-complex.h, ov-flt-cx-diag.cc,
ov-flt-cx-diag.h, ov-flt-cx-mat.cc, ov-flt-cx-mat.h, ov-flt-re-diag.cc,
ov-flt-re-diag.h, ov-flt-re-mat.cc, ov-flt-re-mat.h, ov-int-traits.h,
ov-int16.cc, ov-int16.h, ov-int32.cc, ov-int32.h, ov-int64.cc, ov-int64.h,
ov-int8.cc, ov-int8.h, ov-intx.h, ov-java.cc, ov-java.h, ov-lazy-idx.cc,
ov-lazy-idx.h, ov-mex-fcn.cc, ov-mex-fcn.h, ov-null-mat.cc, ov-null-mat.h,
ov-oncleanup.cc, ov-oncleanup.h, ov-perm.cc, ov-perm.h, ov-range.cc,
ov-range.h, ov-re-diag.cc, ov-re-diag.h, ov-re-mat.cc, ov-re-mat.h,
ov-re-sparse.cc, ov-re-sparse.h, ov-scalar.cc, ov-scalar.h, ov-str-mat.cc,
ov-str-mat.h, ov-struct.cc, ov-struct.h, ov-typeinfo.cc, ov-typeinfo.h,
ov-uint16.cc, ov-uint16.h, ov-uint32.cc, ov-uint32.h, ov-uint64.cc,
ov-uint64.h, ov-uint8.cc, ov-uint8.h, ov-usr-fcn.cc, ov-usr-fcn.h, ov.h,
ovl.cc, ovl.h, octave.cc, octave.h, 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-pm.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-fcm-pm.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-fm-pm.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-int.h,
op-m-cm.cc, op-m-cs.cc, op-m-m.cc, op-m-pm.cc, op-m-s.cc, op-m-scm.cc,
op-m-sm.cc, op-pm-cm.cc, op-pm-fcm.cc, op-pm-fm.cc, op-pm-m.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, options-usage.h, lex.h, parse.h, pt-all.h, pt-arg-list.cc,
pt-arg-list.h, 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.cc,
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-funcall.cc, pt-funcall.h,
pt-id.cc, pt-id.h, pt-idx.cc, pt-idx.h, pt-jump.cc, 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-stmt.cc, pt-stmt.h, pt-unop.cc,
pt-unop.h, pt-walk.h, pt.cc, pt.h, token.cc, token.h, Array-jit.cc,
Array-tc.cc, version.cc, version.in.h:
Style check C++ code in libinterp/
author | Rik <rik@octave.org> |
---|---|
date | Tue, 30 Aug 2016 21:46:47 -0700 |
parents | bac0d6f07a3e |
children | 3a2b891d0b33 e9a0469dedd9 |
line wrap: on
line source
/* Copyright (C) 2013-2016 John W. Eaton Copyright (C) 2011-2016 Jacob Dawid Copyright (C) 2011-2016 John P. Swensen 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 <http://www.gnu.org/licenses/>. */ #if ! defined (octave_octave_link_h) #define octave_octave_link_h 1 #include "octave-config.h" #include <string> #include "event-queue.h" class octave_mutex; class string_vector; class workspace_element; // \class OctaveLink // \brief Provides threadsafe access to octave. // \author Jacob Dawid // // This class is a wrapper around octave and provides thread safety by // buffering access operations to octave and executing them in the // readline event hook, which lives in the octave thread. class OCTINTERP_API octave_link { protected: octave_link (void); public: virtual ~octave_link (void); static void generate_events (void) { if (enabled ()) instance->do_generate_events (); } // If disable is TRUE, then no additional events will be processed // other than exit. static void process_events (bool disable = false) { if (enabled ()) { if (disable) instance->link_enabled = false; instance->do_process_events (); } } static void discard_events (void) { if (enabled ()) instance->do_discard_events (); } static bool confirm_shutdown (void) { bool retval = true; if (instance_ok ()) retval = instance->do_confirm_shutdown (); return retval; } static bool exit (int status) { bool retval = false; if (instance_ok ()) retval = instance->do_exit (status); return retval; } template <typename T> static void post_event (T *obj, void (T::*method) (void)) { if (enabled ()) instance->do_post_event (obj, method); } template <typename T, typename A> static void post_event (T *obj, void (T::*method) (A), A arg) { if (enabled ()) instance->do_post_event (obj, method, arg); } template <typename T, typename A> static void post_event (T *obj, void (T::*method) (const A&), const A& arg) { if (enabled ()) instance->do_post_event (obj, method, arg); } static void entered_readline_hook (void) { if (enabled ()) instance->do_entered_readline_hook (); } static void finished_readline_hook (void) { if (enabled ()) instance->do_finished_readline_hook (); } static bool copy_image_to_clipboard (const std::string& file) { return enabled () ? instance->do_copy_image_to_clipboard (file) : false; } static bool edit_file (const std::string& file) { return enabled () ? instance->do_edit_file (file) : false; } static bool prompt_new_edit_file (const std::string& file) { return enabled () ? instance->do_prompt_new_edit_file (file) : false; } static int message_dialog (const std::string& dlg, const std::string& msg, const std::string& title) { return enabled () ? instance->do_message_dialog (dlg, msg, title) : 0; } static 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 () ? instance->do_question_dialog (msg, title, btn1, btn2, btn3, btndef) : 0; } static 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 () ? instance->do_list_dialog (list, mode, width, height, initial_value, name, prompt, ok_string, cancel_string) : std::pair<std::list<int>, int> (); } static 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 () ? instance->do_input_dialog (prompt, title, nr, nc, defaults) : std::list<std::string> (); } typedef std::list<std::pair<std::string, std::string> > filter_list; static 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 () ? instance->do_file_dialog (filter, title, filename, dirname, multimode) : std::list<std::string> (); } static int debug_cd_or_addpath_error (const std::string& file, const std::string& dir, bool addpath_option) { return enabled () ? instance->do_debug_cd_or_addpath_error (file, dir, addpath_option) : 0; } static void change_directory (const std::string& dir) { if (enabled ()) instance->do_change_directory (dir); } // Preserves pending input. static void execute_command_in_terminal (const std::string& command) { if (enabled ()) instance->do_execute_command_in_terminal (command); } static void set_workspace (void); static void set_workspace (bool top_level, const std::list<workspace_element>& ws) { if (enabled ()) instance->do_set_workspace (top_level, instance->debugging, ws); } static void clear_workspace (void) { if (enabled ()) instance->do_clear_workspace (); } static void set_history (const string_vector& hist) { if (enabled ()) instance->do_set_history (hist); } static void append_history (const std::string& hist_entry) { if (enabled ()) instance->do_append_history (hist_entry); } static void clear_history (void) { if (enabled ()) instance->do_clear_history (); } static void pre_input_event (void) { if (enabled ()) instance->do_pre_input_event (); } static void post_input_event (void) { if (enabled ()) instance->do_post_input_event (); } static void enter_debugger_event (const std::string& file, int line) { if (enabled ()) { instance->debugging = true; instance->do_enter_debugger_event (file, line); } } static void execute_in_debugger_event (const std::string& file, int line) { if (enabled ()) instance->do_execute_in_debugger_event (file, line); } static void exit_debugger_event (void) { if (enabled () && instance->debugging) { instance->debugging = false; instance->do_exit_debugger_event (); } } static void update_breakpoint (bool insert, const std::string& file, int line, const std::string& cond = "") { if (enabled ()) instance->do_update_breakpoint (insert, file, line, cond); } static void connect_link (octave_link *); static void set_default_prompts (std::string& ps1, std::string& ps2, std::string& ps4) { if (enabled ()) instance->do_set_default_prompts (ps1, ps2, ps4); } static bool enabled (void) { return instance_ok () ? instance->link_enabled : false; } static bool show_preferences () { if (enabled ()) { instance->do_show_preferences (); return true; } else return false; } static bool show_doc (const std::string & file) { if (enabled ()) { instance->do_show_doc (file); return true; } else return false; } private: static octave_link *instance; // No copying! octave_link (const octave_link&); octave_link& operator = (const octave_link&); static bool instance_ok (void) { return instance != 0; } protected: // Semaphore to lock access to the event queue. octave_mutex *event_queue_mutex; // Event Queue. event_queue gui_event_queue; bool debugging; bool link_enabled; void do_generate_events (void); void do_process_events (void); void do_discard_events (void); template <typename T> void do_post_event (T *obj, void (T::*method) (void)) { gui_event_queue.add_method (obj, method); } template <typename T, typename A> void do_post_event (T *obj, void (T::*method) (A), A arg) { gui_event_queue.add_method (obj, method, arg); } template <typename T, typename A> void do_post_event (T *obj, void (T::*method) (const A&), const A& arg) { gui_event_queue.add_method (obj, method, arg); } void do_entered_readline_hook (void) { } void do_finished_readline_hook (void) { } virtual bool do_confirm_shutdown (void) = 0; virtual bool do_exit (int status) = 0; virtual bool do_copy_image_to_clipboard (const std::string& file) = 0; virtual bool do_edit_file (const std::string& file) = 0; virtual bool do_prompt_new_edit_file (const std::string& file) = 0; virtual int do_message_dialog (const std::string& dlg, const std::string& msg, const std::string& title) = 0; virtual std::string do_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) = 0; virtual std::pair<std::list<int>, int> do_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) = 0; virtual std::list<std::string> do_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) = 0; virtual std::list<std::string> do_file_dialog (const filter_list& filter, const std::string& title, const std::string& filename, const std::string& dirname, const std::string& multimode) = 0; virtual int do_debug_cd_or_addpath_error (const std::string& file, const std::string& dir, bool addpath_option) = 0; virtual void do_change_directory (const std::string& dir) = 0; virtual void do_execute_command_in_terminal (const std::string& command) = 0; virtual void do_set_workspace (bool top_level, bool debug, const std::list<workspace_element>& ws) = 0; virtual void do_clear_workspace (void) = 0; virtual void do_set_history (const string_vector& hist) = 0; virtual void do_append_history (const std::string& hist_entry) = 0; virtual void do_clear_history (void) = 0; virtual void do_pre_input_event (void) = 0; virtual void do_post_input_event (void) = 0; virtual void do_enter_debugger_event (const std::string& file, int line) = 0; virtual void do_execute_in_debugger_event (const std::string& file, int line) = 0; virtual void do_exit_debugger_event (void) = 0; virtual void do_update_breakpoint (bool insert, const std::string& file, int line, const std::string& cond) = 0; virtual void do_set_default_prompts (std::string& ps1, std::string& ps2, std::string& ps4) = 0; virtual void do_show_preferences (void) = 0; virtual void do_show_doc (const std::string &file) = 0; }; #endif