Mercurial > octave
view libinterp/corefcn/call-stack.h @ 31607:aac27ad79be6 stable
maint: Re-indent code after switch to using namespace macros.
* build-env.h, build-env.in.cc, Cell.h, __betainc__.cc, __eigs__.cc,
__ftp__.cc, __ichol__.cc, __ilu__.cc, __isprimelarge__.cc, __magick_read__.cc,
__pchip_deriv__.cc, amd.cc, base-text-renderer.cc, base-text-renderer.h,
besselj.cc, bitfcns.cc, bsxfun.cc, c-file-ptr-stream.h, call-stack.cc,
call-stack.h, ccolamd.cc, cellfun.cc, chol.cc, colamd.cc, dasrt.cc, data.cc,
debug.cc, defaults.cc, defaults.h, det.cc, display.cc, display.h, dlmread.cc,
dynamic-ld.cc, dynamic-ld.h, 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,
file-io.cc, filter.cc, find.cc, ft-text-renderer.cc, ft-text-renderer.h,
gcd.cc, gl-render.cc, gl-render.h, gl2ps-print.cc, gl2ps-print.h,
graphics-toolkit.cc, graphics-toolkit.h, graphics.cc, gsvd.cc, gtk-manager.cc,
gtk-manager.h, help.cc, help.h, 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, latex-text-renderer.cc,
latex-text-renderer.h, load-path.cc, load-path.h, load-save.cc, load-save.h,
lookup.cc, ls-hdf5.cc, ls-mat4.cc, ls-mat5.cc, lsode.cc, lu.cc, mappers.cc,
matrix_type.cc, max.cc, mex.cc, mexproto.h, mxarray.h, mxtypes.in.h,
oct-errno.in.cc, oct-hdf5-types.cc, oct-hist.cc, oct-hist.h, oct-map.cc,
oct-map.h, oct-opengl.h, oct-prcstrm.h, oct-process.cc, oct-process.h,
oct-stdstrm.h, oct-stream.cc, oct-stream.h, oct-strstrm.h,
octave-default-image.h, ordqz.cc, ordschur.cc, pager.cc, pager.h, pinv.cc,
pow2.cc, pr-output.cc, psi.cc, qr.cc, quadcc.cc, rand.cc, regexp.cc,
settings.cc, settings.h, sighandlers.cc, sighandlers.h, sparse-xpow.cc,
sqrtm.cc, stack-frame.cc, stack-frame.h, stream-euler.cc, strfns.cc, svd.cc,
syminfo.cc, syminfo.h, symrcm.cc, symrec.cc, symrec.h, symscope.cc, symscope.h,
symtab.cc, symtab.h, sysdep.cc, sysdep.h, text-engine.cc, text-engine.h,
text-renderer.cc, text-renderer.h, time.cc, toplev.cc, typecast.cc,
url-handle-manager.cc, url-handle-manager.h, urlwrite.cc, utils.cc, utils.h,
variables.cc, variables.h, xdiv.cc, __delaunayn__.cc, __init_fltk__.cc,
__init_gnuplot__.cc, __ode15__.cc, __voronoi__.cc, audioread.cc, convhulln.cc,
gzip.cc, 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-diag.cc, ov-base-int.cc, ov-base-mat.cc,
ov-base-mat.h, ov-base-scalar.cc, ov-base.cc, ov-base.h, ov-bool-mat.cc,
ov-bool-mat.h, ov-bool-sparse.cc, ov-bool.cc, ov-builtin.h, ov-cell.cc,
ov-ch-mat.cc, ov-class.cc, ov-class.h, ov-classdef.cc, ov-classdef.h,
ov-complex.cc, ov-cx-diag.cc, ov-cx-mat.cc, ov-cx-sparse.cc, ov-dld-fcn.cc,
ov-dld-fcn.h, ov-fcn-handle.cc, ov-fcn-handle.h, ov-fcn.h, ov-float.cc,
ov-flt-complex.cc, ov-flt-cx-diag.cc, ov-flt-cx-mat.cc, ov-flt-re-diag.cc,
ov-flt-re-mat.cc, ov-flt-re-mat.h, ov-intx.h, ov-java.cc, ov-lazy-idx.cc,
ov-legacy-range.cc, ov-magic-int.cc, ov-mex-fcn.cc, ov-mex-fcn.h,
ov-null-mat.cc, ov-perm.cc, ov-range.cc, ov-re-diag.cc, ov-re-mat.cc,
ov-re-mat.h, ov-re-sparse.cc, ov-scalar.cc, ov-str-mat.cc, ov-struct.cc,
ov-typeinfo.cc, ov-typeinfo.h, ov-usr-fcn.cc, ov-usr-fcn.h, ov.cc, ov.h, ovl.h,
octave.cc, octave.h, op-b-sbm.cc, op-bm-sbm.cc, op-cs-scm.cc, op-fm-fcm.cc,
op-fs-fcm.cc, op-s-scm.cc, op-scm-cs.cc, op-scm-s.cc, op-sm-cs.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, oct-lvalue.cc, oct-lvalue.h,
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-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:
Re-indent code after switch to using namespace macros.
author | Rik <rik@octave.org> |
---|---|
date | Thu, 01 Dec 2022 18:02:15 -0800 |
parents | e88a07dec498 |
children | 597f3ee61a48 |
line wrap: on
line source
//////////////////////////////////////////////////////////////////////// // // Copyright (C) 1993-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_call_stack_h) #define octave_call_stack_h 1 #include "octave-config.h" #include <deque> #include <memory> #include <string> class octave_function; class octave_map; class octave_user_code; class octave_user_script; class octave_value; class octave_value_list; #include "quit.h" #include "stack-frame.h" #include "symscope.h" OCTAVE_BEGIN_NAMESPACE(octave) class tree_evaluator; class symbol_info_list; class unwind_protect; class OCTINTERP_API call_stack { public: typedef std::deque<std::shared_ptr<stack_frame>> stack_frames; typedef stack_frames::iterator iterator; typedef stack_frames::const_iterator const_iterator; typedef stack_frames::reverse_iterator reverse_iterator; typedef stack_frames::const_reverse_iterator const_reverse_iterator; call_stack (tree_evaluator& evaluator); // Lock current function. Look for the first stack frame that is // a function. If SKIP_FIST is true, then skip the first frame. // That allows functions like Fmlock to find and lock the calling // function instead of locking Fmlock itself. octave_function * current_function (bool skip_first = false) const; octave_function * caller_function (void) const { return current_function (true); } // Current line in current function. int current_line (void) const; // Current column in current function. int current_column (void) const; std::size_t current_frame (void) const { return m_curr_frame; } std::size_t size (void) const { return m_cs.size (); } std::shared_ptr<stack_frame> get_current_stack_frame (void) const { return m_cs[m_curr_frame]; } symbol_scope top_scope (void) const { return m_cs[0]->get_scope (); } symbol_scope current_scope (void) const { // FIXME: Can m_curr_frame ever be invalid? return (m_curr_frame < m_cs.size () ? m_cs[m_curr_frame]->get_scope () : symbol_scope ()); } bool at_top_level (void) const { return current_scope () == top_scope (); } // Function at location N on the call stack (N == 0 is current), may // be built-in. octave_function * element (std::size_t n) { octave_function *retval = nullptr; if (m_cs.size () > n) retval = m_cs[n]->function (); return retval; } // User code caller. octave_user_code * current_user_code (void) const; unwind_protect * curr_fcn_unwind_protect_frame (void); // Line in user code caller. int current_user_code_line (void) const; // Column in user code caller. int current_user_code_column (void) const; // Current function that we are debugging. octave_user_code * debug_user_code (void) const; // Line number in current function that we are debugging. int debug_user_code_line (void) const; // Column number in current function that we are debugging. int debug_user_code_column (void) const; std::string get_dispatch_class (void) const; void set_dispatch_class (const std::string& class_name); bool is_class_method_executing (std::string& dispatch_class) const; bool is_class_constructor_executing (std::string& dispatch_class) const; // Return TRUE if all elements on the call stack are scripts. bool all_scripts (void) const; void push (const symbol_scope& scope); void push (octave_user_function *fcn, const std::shared_ptr<stack_frame>& closure_frames = std::shared_ptr<stack_frame> ()); void push (octave_user_function *fcn, const stack_frame::local_vars_map& local_vars, const std::shared_ptr<stack_frame>& closure_frames = std::shared_ptr<stack_frame> ()); void push (octave_user_script *script); void push (octave_function *fcn); void set_location (int l, int c) { if (! m_cs.empty ()) { std::shared_ptr<stack_frame> elt = m_cs.back (); elt->line (l); elt->column (c); } } void set_line (int l) { if (! m_cs.empty ()) { std::shared_ptr<stack_frame> elt = m_cs.back (); elt->line (l); } } void set_column (int c) { if (! m_cs.empty ()) { std::shared_ptr<stack_frame> elt = m_cs.back (); elt->column (c); } } bool goto_frame (std::size_t n = 0, bool verbose = false); void restore_frame (std::size_t n) { goto_frame (n); } std::size_t find_current_user_frame (void) const; std::shared_ptr<stack_frame> current_user_frame (void) const; std::size_t dbupdown (std::size_t start, int n, bool verbose); std::size_t dbupdown (int n = -1, bool verbose = false); void goto_caller_frame (void); void goto_base_frame (void); std::list<std::shared_ptr<stack_frame>> backtrace_frames (octave_idx_type& curr_user_frame) const; // List of raw stack frames. std::list<std::shared_ptr<stack_frame>> backtrace_frames (void) const; // List of stack_info objects that can be used in liboctave and // stored in the execution_exception object. std::list<frame_info> backtrace_info (octave_idx_type& curr_user_frame, bool print_subfn = true) const; std::list<frame_info> backtrace_info (void) const; // The same as backtrace_info but in the form of a struct array // object that may be used in the interpreter. octave_map backtrace (octave_idx_type& curr_user_frame, bool print_subfn = true) const; octave_map backtrace (void) const; octave_map empty_backtrace (void) const; void pop (void); void clear (void); symbol_info_list all_variables (void); std::list<std::string> global_variable_names (void) const; std::list<std::string> top_level_variable_names (void) const; std::list<std::string> variable_names (void) const; void clear_global_variable (const std::string& name); void clear_global_variable_pattern (const std::string& pattern); void clear_global_variable_regexp(const std::string& pattern); void clear_global_variables (void); symbol_info_list glob_symbol_info (const std::string& pattern) const; symbol_info_list regexp_symbol_info (const std::string& pattern) const; symbol_info_list get_symbol_info (void); symbol_info_list top_scope_symbol_info (void) const; octave_value max_stack_depth (const octave_value_list& args, int nargout); void make_persistent (const symbol_record& sym); void make_global (const symbol_record& sym); octave_value global_varval (const std::string& name) const; octave_value& global_varref (const std::string& name); octave_value get_top_level_value (const std::string& name) const; void set_top_level_value (const std::string& name, const octave_value& value); octave_value do_who (int argc, const string_vector& argv, bool return_list, bool verbose = false); octave_value do_who_two (const string_vector& patterns, bool have_regexp, bool return_list, bool verbose, const std::string& msg = ""); octave_value do_global_who_two (const string_vector& patterns, bool have_regexp, bool return_list, bool verbose, const std::string& msg = ""); void display (void) const; void set_auto_fcn_var (stack_frame::auto_var_type avt, const octave_value& val); octave_value get_auto_fcn_var (stack_frame::auto_var_type avt) const; private: void get_new_frame_index_and_links (std::size_t& new_frame_idx, std::shared_ptr<stack_frame>& parent_link, std::shared_ptr<stack_frame>& static_link) const; tree_evaluator& m_evaluator; // The list of stack frames. stack_frames m_cs; // The current frame. When a new frame is pushed, m_curr_frame // moves to the end of the list of stack frames (also referred to as // the top of the call stack) but may be temporarily moved to // another location by evalin or debugging functions. // FIXME: should the current frame be managed by the evaluator // instead? std::size_t m_curr_frame; int m_max_stack_depth; std::map<std::string, octave_value> m_global_values; }; OCTAVE_END_NAMESPACE(octave) #endif