Mercurial > octave
view libinterp/octave.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 | 83f9f8bda883 |
children | aac27ad79be6 |
line wrap: on
line source
//////////////////////////////////////////////////////////////////////// // // Copyright (C) 2002-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_octave_h) #define octave_octave_h 1 #include "octave-config.h" #include <list> #include <memory> #include <string> #include "str-vec.h" class octave_value; OCTAVE_BEGIN_NAMESPACE(octave) // Command line arguments. See also options.h. class OCTINTERP_API cmdline_options { public: cmdline_options (void); cmdline_options (int argc, char **argv); cmdline_options (const cmdline_options&) = default; cmdline_options& operator = (const cmdline_options&) = default; int sys_argc (void) const { return m_all_args.numel (); } char **sys_argv (void) const { return m_all_args.c_str_vec (); } bool echo_commands (void) const { return m_echo_commands; } bool experimental_terminal_widget (void) const { return m_experimental_terminal_widget; } bool forced_interactive (void) const { return m_forced_interactive; } bool forced_line_editing (void) const { return m_forced_line_editing; } bool gui (void) const { return m_gui; } bool inhibit_startup_message (void) const { return m_inhibit_startup_message; } bool line_editing (void) const { return m_line_editing; } bool no_window_system (void) const { return m_no_window_system; } bool persist (void) const { return m_persist; } bool read_history_file (void) const { return m_read_history_file; } bool read_init_files (void) const { return m_read_init_files; } bool read_site_files (void) const { return m_read_site_files; } bool server (void) const { return m_server; } bool set_initial_path (void) const { return m_set_initial_path; } bool traditional (void) const { return m_traditional; } bool verbose_flag (void) const { return m_verbose_flag; } std::string code_to_eval (void) const { return m_code_to_eval; } std::list<std::string> command_line_path (void) const { return m_command_line_path; } std::string docstrings_file (void) const { return m_docstrings_file; } std::string doc_cache_file (void) const { return m_doc_cache_file; } std::string exec_path (void) const { return m_exec_path; } std::string image_path (void) const { return m_image_path; } std::string info_file (void) const { return m_info_file; } std::string info_program (void) const { return m_info_program; } std::string texi_macros_file (void) const {return m_texi_macros_file; } string_vector all_args (void) const { return m_all_args; } string_vector remaining_args (void) const { return m_remaining_args; } void echo_commands (bool arg) { m_echo_commands = arg; } void experimental_terminal_widget (bool arg) { m_experimental_terminal_widget = arg; } void forced_line_editing (bool arg) { m_forced_line_editing = arg; } void forced_interactive (bool arg) { m_forced_interactive = arg; } void gui (bool arg) { m_gui = arg; } void inhibit_startup_message (bool arg) { m_inhibit_startup_message = arg; } void line_editing (bool arg) { m_line_editing = arg; } void no_window_system (bool arg) { m_no_window_system = arg; } void persist (bool arg) { m_persist = arg; } void read_history_file (bool arg) { m_read_history_file = arg; } void read_init_files (bool arg) { m_read_init_files = arg; } void read_site_files (bool arg) { m_read_site_files = arg; } void server (bool arg) { m_server = arg; } void set_initial_path (bool arg) { m_set_initial_path = arg; } void traditional (bool arg) { m_traditional = arg; } void verbose_flag (bool arg) { m_verbose_flag = arg; } void code_to_eval (const std::string& arg) { m_code_to_eval = arg; } void command_line_path (const std::list<std::string>& arg) { m_command_line_path = arg; } void docstrings_file (const std::string& arg) { m_docstrings_file = arg; } void doc_cache_file (const std::string& arg) { m_doc_cache_file = arg; } void exec_path (const std::string& arg) { m_exec_path = arg; } void image_path (const std::string& arg) { m_image_path = arg; } void info_file (const std::string& arg) { m_info_file = arg; } void info_program (const std::string& arg) { m_info_program = arg; } void texi_macros_file (const std::string& arg) { m_texi_macros_file = arg; } void all_args (const string_vector& arg) { m_all_args = arg; } void remaining_args (const string_vector& arg) { m_remaining_args = arg; } octave_value as_octave_value (void) const; private: // If TRUE, echo commands as they are read and executed. // (--echo-commands, -x) bool m_echo_commands = false; // If TRUE, use new experimental terminal widget in the GUI. // (--experimental-terminal-widget) bool m_experimental_terminal_widget = false; // If TRUE, start the GUI. // (--gui) and (--force-gui) for backwards compatibility bool m_gui = false; // TRUE means the user forced this shell to be interactive. // (--interactive, -i) bool m_forced_interactive = false; // If TRUE, force readline command line editing. // (--line-editing) bool m_forced_line_editing = false; // TRUE means we don't print the usual startup message. // (--quiet; --silent; -q) bool m_inhibit_startup_message = false; // TRUE means we are using readline. // (--no-line-editing) bool m_line_editing = true; // If TRUE, ignore the window system even if it is available. // (--no-window-system, -W) bool m_no_window_system = false; // If TRUE, don't exit after evaluating code given by --eval option. // (--persist) bool m_persist = false; // If TRUE, initialize history list from saved history file. // (--no-history; -H) bool m_read_history_file = true; // TRUE means we read ~/.octaverc and ./.octaverc. // (--norc; --no-init-file; -f) bool m_read_init_files = true; // TRUE means we read the site-wide octaverc files. // (--norc; --no-site-file; -f) bool m_read_site_files = true; // If TRUE, start the command server. // (--server) bool m_server = false; // TRUE means we set the initial path to configured defaults. // (--no-init-path) bool m_set_initial_path = true; // If TRUE use traditional (maximally MATLAB compatible) settings // (--traditional) bool m_traditional = false; // If TRUE, print verbose info in some cases. // (--verbose; -V) bool m_verbose_flag = false; // The code to evaluate at startup // (--eval CODE) std::string m_code_to_eval; // The value of "path" specified on the command line. // (--path; -p) std::list<std::string> m_command_line_path; // The value for "built_in_docstrings_file" specified on the // command line. // (--built-in-docstrings-file) std::string m_docstrings_file; // The value for "doc_cache_file" specified on the command line. // (--doc-cache-file) std::string m_doc_cache_file; // The value for "EXEC_PATH" specified on the command line. // (--exec-path) std::string m_exec_path; // The value for "IMAGE_PATH" specified on the command line. // (--image-path) std::string m_image_path; // The value for "info_file" specified on the command line. // (--info-file) std::string m_info_file; // The value for "info_program" specified on the command line. // (--info-program) std::string m_info_program; // The value for "texi_macos_file" specified on the command line. // (--texi-macros-file) std::string m_texi_macros_file; // All arguments passed to the argc, argv constructor. string_vector m_all_args; // Arguments remaining after parsing. string_vector m_remaining_args; }; // The application object contains a pointer to the current // interpreter and the interpreter contains a pointer back to the // application context so we need a forward declaration for one (or // both) of them... class interpreter; // Base class for an Octave application. class OCTINTERP_API application { public: application (const cmdline_options& opts = cmdline_options ()); application (int argc, char **argv); // No copying, at least not yet... application (const application&) = delete; application& operator = (const application&) = delete; virtual ~application (void); int sys_argc (void) const { return m_options.sys_argc (); } char **sys_argv (void) const { return m_options.sys_argv (); } void set_program_names (const std::string& pname); void intern_argv (const string_vector& args); cmdline_options options (void) const { return m_options; } bool have_eval_option_code (void) const { return m_have_eval_option_code; } bool have_script_file (void) const { return m_have_script_file; } bool is_octave_program (void) const { return m_is_octave_program; } bool interpreter_initialized (void); virtual interpreter& create_interpreter (void); virtual void initialize_interpreter (void); virtual int execute_interpreter (void); virtual void delete_interpreter (void); virtual int execute (void) = 0; virtual bool gui_running (void) const { return false; } virtual void gui_running (bool) { } void program_invocation_name (const std::string& nm) { m_program_invocation_name = nm; } void program_name (const std::string& nm) { m_program_name = nm; } void forced_interactive (bool arg) { m_options.forced_interactive (arg); } // Provided for convenience. Will be removed once we eliminate the // old terminal widget. bool experimental_terminal_widget (void) const; static application * app (void) { return s_instance; } static std::string program_invocation_name (void) { return s_instance ? s_instance->m_program_invocation_name : ""; } static std::string program_name (void) { return s_instance ? s_instance->m_program_name : ""; } static string_vector argv (void) { return s_instance ? s_instance->m_argv : string_vector (); } static bool is_gui_running (void) { return s_instance ? s_instance->gui_running () : false; } // Convenience functions. static bool forced_interactive (void); private: // The application instance; There should be only one. static application *s_instance; void init (void); protected: // The name used to invoke Octave. std::string m_program_invocation_name; // The last component of octave_program_invocation_name. std::string m_program_name; // The current argument vector (may change if we are running a // script with --persist because after the script is done, the // arguments revert to the full list given to the octave // interpreter at startup. string_vector m_argv; cmdline_options m_options; // TRUE means we have --eval CODE bool m_have_eval_option_code = false; // TRUE if there is a command line argument that looks like the // name of a file to execute. bool m_have_script_file = false; // TRUE if this is a program and no interpreter and interaction is // needed. For example, an octave program with shebang line, or code // from eval without persist. bool m_is_octave_program = false; std::unique_ptr<interpreter> m_interpreter; }; class OCTINTERP_API cli_application : public application { public: cli_application (const cmdline_options& opts = cmdline_options ()) : application (opts) { } cli_application (int argc, char **argv) : application (argc, argv) { } // No copying, at least not yet... cli_application (const cli_application&) = delete; cli_application& operator = (const cli_application&) = delete; ~cli_application (void) = default; int execute (void); }; OCTAVE_END_NAMESPACE(octave) #endif