Mercurial > octave
view libinterp/corefcn/call-stack.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 | dd80fb1ef949 |
line wrap: on
line source
/* Copyright (C) 1993-2016 John W. Eaton 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_call_stack_h) #define octave_call_stack_h 1 #include "octave-config.h" #include <deque> #include <string> class octave_function; class octave_user_code; class octave_user_script; #include "input.h" #include "oct-map.h" #include "symtab.h" class OCTINTERP_API octave_call_stack { protected: octave_call_stack (void) : cs (), curr_frame (0) { } public: class stack_frame { public: friend class octave_call_stack; stack_frame (octave_function *fcn = 0, symbol_table::scope_id scope = 0, symbol_table::context_id context = 0, size_t prev = 0) : m_fcn (fcn), m_line (-1), m_column (-1), m_scope (scope), m_context (context), m_prev (prev) { } stack_frame (const stack_frame& elt) : m_fcn (elt.m_fcn), m_line (elt.m_line), m_column (elt.m_column), m_scope (elt.m_scope), m_context (elt.m_context), m_prev (elt.m_prev) { } int line (void) const { return m_line; } int column (void) const { return m_column; } std::string fcn_file_name (void) const; std::string fcn_name (bool print_subfn = true) const; bool operator== (const stack_frame &rhs) const; private: octave_function *m_fcn; int m_line; int m_column; symbol_table::scope_id m_scope; symbol_table::context_id m_context; size_t m_prev; }; typedef std::deque<stack_frame>::iterator iterator; typedef std::deque<stack_frame>::const_iterator const_iterator; typedef std::deque<stack_frame>::reverse_iterator reverse_iterator; typedef std::deque<stack_frame>::const_reverse_iterator const_reverse_iterator; static void create_instance (void); static bool instance_ok (void) { bool retval = true; if (! instance) create_instance (); if (! instance) error ("unable to create call stack object!"); return retval; } // Current function (top of stack). static octave_function *current (void) { return instance_ok () ? instance->do_current () : 0; } // Current line in current function. static int current_line (void) { return instance_ok () ? instance->do_current_line () : -1; } // Current column in current function. static int current_column (void) { return instance_ok () ? instance->do_current_column () : -1; } // Caller function, may be built-in. static octave_function *caller (void) { return instance_ok () ? instance->do_caller () : 0; } static size_t current_frame (void) { return instance_ok () ? instance->do_current_frame () : 0; } static size_t size (void) { return instance_ok () ? instance->do_size () : 0; } static size_t num_user_code_frames (octave_idx_type& curr_user_frame) { return instance_ok () ? instance->do_num_user_code_frames (curr_user_frame) : 0; } static symbol_table::scope_id current_scope (void) { return instance_ok () ? instance->do_current_scope () : 0; } static symbol_table::context_id current_context (void) { return instance_ok () ? instance->do_current_context () : 0; } #if 0 static stack_frame frame (size_t idx) { return instance_ok () ? instance->do_frame (idx) : stack_frame (); } #endif // Function at location N on the call stack (N == 0 is current), may // be built-in. static octave_function *element (size_t n) { return instance_ok () ? instance->do_element (n) : 0; } // User code caller. static octave_user_code *caller_user_code (size_t nskip = 0) { return instance_ok () ? instance->do_caller_user_code (nskip) : 0; } // Line in user code caller. static int caller_user_code_line (void) { return instance_ok () ? instance->do_caller_user_code_line () : -1; } // Column in user code caller. static int caller_user_code_column (void) { return instance_ok () ? instance->do_caller_user_code_column () : -1; } // Current function that we are debugging. static octave_user_code *debug_user_code (void) { return instance_ok () ? instance->do_debug_user_code () : 0; } // Line number in current function that we are debugging. static int debug_user_code_line (void) { return instance_ok () ? instance->do_debug_user_code_line () : 0; } // Column number in current function that we are debugging. static int debug_user_code_column (void) { return instance_ok () ? instance->do_debug_user_code_column () : 0; } // Return TRUE if all elements on the call stack are scripts. static bool all_scripts (void) { return instance_ok () ? instance->do_all_scripts () : false; } static void push (octave_function *f, symbol_table::scope_id scope = symbol_table::current_scope (), symbol_table::context_id context = symbol_table::current_context ()) { if (instance_ok ()) instance->do_push (f, scope, context); } static void push (symbol_table::scope_id scope = symbol_table::current_scope (), symbol_table::context_id context = symbol_table::current_context ()) { if (instance_ok ()) instance->do_push (0, scope, context); } static void set_location (int l, int c) { if (instance_ok ()) instance->do_set_location (l, c); } static void set_line (int l) { if (instance_ok ()) instance->do_set_line (l); } static void set_column (int c) { if (instance_ok ()) instance->do_set_column (c); } static bool goto_frame (size_t n = 0, bool verbose = false) { return instance_ok () ? instance->do_goto_frame (n, verbose) : false; } static void restore_frame (size_t n) { goto_frame (n); } static bool goto_frame_relative (int n, bool verbose = false) { return instance_ok () ? instance->do_goto_frame_relative (n, verbose) : false; } static void goto_caller_frame (void) { if (instance_ok ()) instance->do_goto_caller_frame (); } static void goto_base_frame (void) { if (instance_ok ()) instance->do_goto_base_frame (); } static octave_map backtrace (size_t nskip = 0) { octave_idx_type curr_user_frame = -1; return instance_ok () ? instance->do_backtrace (nskip, curr_user_frame, true) : octave_map (); } static octave_map backtrace (size_t nskip, octave_idx_type& curr_user_frame, bool print_subfn = true) { return instance_ok () ? instance->do_backtrace (nskip, curr_user_frame, print_subfn) : octave_map (); } static std::list<octave_call_stack::stack_frame> backtrace_frames (size_t nskip = 0) { octave_idx_type curr_user_frame = -1; return instance_ok () ? instance->do_backtrace_frames (nskip, curr_user_frame) : std::list<octave_call_stack::stack_frame> (); } static std::list<octave_call_stack::stack_frame> backtrace_frames (size_t nskip, octave_idx_type& curr_user_frame) { return instance_ok () ? instance->do_backtrace_frames (nskip, curr_user_frame) : std::list<octave_call_stack::stack_frame> (); } static octave_map empty_backtrace (void); static void pop (void) { if (instance_ok ()) instance->do_pop (); } static void clear (void) { if (instance_ok ()) instance->do_clear (); } private: // The current call stack. std::deque<stack_frame> cs; size_t curr_frame; static octave_call_stack *instance; static void cleanup_instance (void) { delete instance; instance = 0; } int do_current_line (void) const; int do_current_column (void) const; octave_function *do_caller (void) const { return curr_frame > 1 ? cs[curr_frame-1].m_fcn : cs[0].m_fcn; } size_t do_current_frame (void) { return curr_frame; } size_t do_size (void) { return cs.size (); } size_t do_num_user_code_frames (octave_idx_type& curr_user_frame) const; symbol_table::scope_id do_current_scope (void) const { return curr_frame > 0 && curr_frame < cs.size () ? cs[curr_frame].m_scope : 0; } symbol_table::context_id do_current_context (void) const { return curr_frame > 0 && curr_frame < cs.size () ? cs[curr_frame].m_context : 0; } #if 0 const stack_frame& do_frame (size_t idx) { static stack_frame foobar; return idx < cs.size () ? cs[idx] : foobar; } #endif octave_function *do_element (size_t n) { octave_function *retval = 0; if (cs.size () > n) { stack_frame& elt = cs[n]; retval = elt.m_fcn; } return retval; } octave_user_code *do_caller_user_code (size_t nskip) const; int do_caller_user_code_line (void) const; int do_caller_user_code_column (void) const; octave_user_code *do_debug_user_code (void) const; int do_debug_user_code_line (void) const; int do_debug_user_code_column (void) const; bool do_all_scripts (void) const; void do_push (octave_function *fcn, symbol_table::scope_id scope, symbol_table::context_id context) { size_t prev_frame = curr_frame; curr_frame = cs.size (); cs.push_back (stack_frame (fcn, scope, context, prev_frame)); symbol_table::set_scope_and_context (scope, context); } octave_function *do_current (void) const { octave_function *retval = 0; if (! cs.empty ()) { const stack_frame& elt = cs[curr_frame]; retval = elt.m_fcn; } return retval; } void do_set_location (int l, int c) { if (! cs.empty ()) { stack_frame& elt = cs.back (); elt.m_line = l; elt.m_column = c; } } void do_set_line (int l) { if (! cs.empty ()) { stack_frame& elt = cs.back (); elt.m_line = l; } } void do_set_column (int c) { if (! cs.empty ()) { stack_frame& elt = cs.back (); elt.m_column = c; } } std::list<octave_call_stack::stack_frame> do_backtrace_frames (size_t nskip, octave_idx_type& curr_user_frame) const; octave_map do_backtrace (size_t nskip, octave_idx_type& curr_user_frame, bool print_subfn) const; bool do_goto_frame (size_t n, bool verbose); bool do_goto_frame_relative (int n, bool verbose); void do_goto_caller_frame (void); void do_goto_base_frame (void); void do_pop (void) { if (cs.size () > 1) { const stack_frame& elt = cs.back (); curr_frame = elt.m_prev; cs.pop_back (); const stack_frame& new_elt = cs[curr_frame]; symbol_table::set_scope_and_context (new_elt.m_scope, new_elt.m_context); } } void do_clear (void) { cs.clear (); } }; #endif