Mercurial > octave
view libinterp/corefcn/call-stack.h @ 29358:0a5b15007766 stable
update Octave Project Developers copyright for the new year
In files that have the "Octave Project Developers" copyright notice,
update for 2021.
author | John W. Eaton <jwe@octave.org> |
---|---|
date | Wed, 10 Feb 2021 09:52:15 -0500 |
parents | 336356206de7 |
children | 34d06c73b48d |
line wrap: on
line source
//////////////////////////////////////////////////////////////////////// // // Copyright (C) 1993-2021 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" 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; size_t current_frame (void) const { return m_curr_frame; } 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 (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); 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 (size_t n = 0, bool verbose = false); void restore_frame (size_t n) { goto_frame (n); } size_t find_current_user_frame (void) const; std::shared_ptr<stack_frame> current_user_frame (void) const; size_t dbupdown (size_t start, int n, bool verbose); 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 (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? size_t m_curr_frame; int m_max_stack_depth; std::map<std::string, octave_value> m_global_values; }; } #endif