Mercurial > octave
view libinterp/corefcn/toplev.h @ 21244:1473547f50f5
include octave-config.h in public header files
* mk-opts.pl, mkbuiltins, mk-ops.awk, sparse-mk-ops.awk:
Emit "#include octave-config.h" statement for generated header files.
* build-env.h, builtins.h, Cell.h, base-text-renderer.h,
c-file-ptr-stream.h, cdisplay.h, comment-list.h, data.h, debug.h,
defaults.in.h, defun-dld.h, defun-int.h, defun.h, dirfns.h, display.h,
dynamic-ld.h, error.h, errwarn.h, event-queue.h, file-io.h,
ft-text-renderer.h, gl-render.h, gl2ps-print.h, graphics.in.h,
gripes.h, help.h, hook-fcn.h, input.h, jit-ir.h, jit-typeinfo.h,
jit-util.h, load-path.h, load-save.h, ls-ascii-helper.h, ls-hdf5.h,
ls-mat-ascii.h, ls-mat4.h, ls-mat5.h, ls-oct-binary.h, ls-oct-text.h,
ls-utils.h, mex.h, mexproto.h, mxarray.in.h, oct-errno.h, oct-fstrm.h,
oct-handle.h, oct-hdf5-types.h, oct-hdf5.h, oct-hist.h, oct-iostrm.h,
oct-lvalue.h, oct-map.h, oct-obj.h, oct-opengl.h, oct-prcstrm.h,
oct-procbuf.h, oct-stdstrm.h, oct-stream.h, oct-strstrm.h, oct.h,
octave-default-image.h, octave-link.h, octave-preserve-stream-state.h,
pager.h, pr-output.h, procstream.h, profiler.h, pt-jit.h,
sighandlers.h, siglist.h, sparse-xdiv.h, sparse-xpow.h, symtab.h,
sysdep.h, text-renderer.h, toplev.h, txt-eng.h, utils.h, variables.h,
workspace-element.h, xdiv.h, xnorm.h, xpow.h, zfstream.h, oct-qhull.h,
ov-base-diag.h, ov-base-int.h, ov-base-mat.h, ov-base-scalar.h,
ov-base-sparse.h, ov-base.h, ov-bool-mat.h, ov-bool-sparse.h,
ov-bool.h, ov-builtin.h, ov-cell.h, ov-ch-mat.h, ov-class.h,
ov-classdef.h, ov-colon.h, ov-complex.h, ov-cs-list.h, ov-cx-diag.h,
ov-cx-mat.h, ov-cx-sparse.h, ov-dld-fcn.h, ov-fcn-handle.h,
ov-fcn-inline.h, ov-fcn.h, ov-float.h, ov-flt-complex.h,
ov-flt-cx-diag.h, ov-flt-cx-mat.h, ov-flt-re-diag.h, ov-flt-re-mat.h,
ov-int-traits.h, ov-int16.h, ov-int32.h, ov-int64.h, ov-int8.h,
ov-intx.h, ov-java.h, ov-lazy-idx.h, ov-mex-fcn.h, ov-null-mat.h,
ov-oncleanup.h, ov-perm.h, ov-range.h, ov-re-diag.h, ov-re-mat.h,
ov-re-sparse.h, ov-scalar.h, ov-str-mat.h, ov-struct.h,
ov-type-conv.h, ov-typeinfo.h, ov-uint16.h, ov-uint32.h, ov-uint64.h,
ov-uint8.h, ov-usr-fcn.h, ov.h, ovl.h, octave.h, op-int.h, ops.h,
options-usage.h, lex.h, parse.h, pt-all.h, pt-arg-list.h,
pt-array-list.h, pt-assign.h, pt-binop.h, pt-bp.h, pt-cbinop.h,
pt-cell.h, pt-check.h, pt-classdef.h, pt-cmd.h, pt-colon.h,
pt-const.h, pt-decl.h, pt-eval.h, pt-except.h, pt-exp.h,
pt-fcn-handle.h, pt-funcall.h, pt-id.h, pt-idx.h, pt-jump.h,
pt-loop.h, pt-mat.h, pt-misc.h, pt-pr-code.h, pt-select.h, pt-stmt.h,
pt-unop.h, pt-walk.h, pt.h, token.h, version.in.h, Array-util.h,
Array.h, CColVector.h, CDiagMatrix.h, CMatrix.h, CNDArray.h,
CRowVector.h, CSparse.h, DiagArray2.h, MArray.h, MDiagArray2.h,
MSparse.h, Matrix.h, MatrixType.h, PermMatrix.h, Range.h, Sparse.h,
boolMatrix.h, boolNDArray.h, boolSparse.h, chMatrix.h, chNDArray.h,
dColVector.h, dDiagMatrix.h, dMatrix.h, dNDArray.h, dRowVector.h,
dSparse.h, dim-vector.h, fCColVector.h, fCDiagMatrix.h, fCMatrix.h,
fCNDArray.h, fCRowVector.h, fColVector.h, fDiagMatrix.h, fMatrix.h,
fNDArray.h, fRowVector.h, idx-vector.h, int16NDArray.h,
int32NDArray.h, int64NDArray.h, int8NDArray.h, intNDArray.h,
uint16NDArray.h, uint32NDArray.h, uint64NDArray.h, uint8NDArray.h,
f77-fcn.h, lo-error.h, quit.h, CmplxAEPBAL.h, CmplxCHOL.h,
CmplxGEPBAL.h, CmplxHESS.h, CmplxLU.h, CmplxQR.h, CmplxQRP.h,
CmplxSCHUR.h, CmplxSVD.h, CollocWt.h, DAE.h, DAEFunc.h, DAERT.h,
DAERTFunc.h, DASPK.h, DASRT.h, DASSL.h, DET.h, EIG.h, LSODE.h, ODE.h,
ODEFunc.h, ODES.h, ODESFunc.h, Quad.h, base-aepbal.h, base-dae.h,
base-de.h, base-lu.h, base-min.h, base-qr.h, bsxfun-decl.h, bsxfun.h,
dbleAEPBAL.h, dbleCHOL.h, dbleGEPBAL.h, dbleHESS.h, dbleLU.h,
dbleQR.h, dbleQRP.h, dbleSCHUR.h, dbleSVD.h, eigs-base.h,
fCmplxAEPBAL.h, fCmplxCHOL.h, fCmplxGEPBAL.h, fCmplxHESS.h,
fCmplxLU.h, fCmplxQR.h, fCmplxQRP.h, fCmplxSCHUR.h, fCmplxSVD.h,
fEIG.h, floatAEPBAL.h, floatCHOL.h, floatGEPBAL.h, floatHESS.h,
floatLU.h, floatQR.h, floatQRP.h, floatSCHUR.h, floatSVD.h,
lo-mappers.h, lo-specfun.h, oct-convn.h, oct-fftw.h, oct-norm.h,
oct-rand.h, oct-spparms.h, randgamma.h, randmtzig.h, randpoisson.h,
sparse-chol.h, sparse-dmsolve.h, sparse-lu.h, sparse-qr.h,
Sparse-diag-op-defs.h, Sparse-op-decls.h, Sparse-op-defs.h,
Sparse-perm-op-defs.h, mx-base.h, mx-defs.h, mx-ext.h, mx-op-decl.h,
mx-op-defs.h, dir-ops.h, file-ops.h, file-stat.h, lo-sysdep.h,
mach-info.h, oct-env.h, oct-group.h, oct-openmp.h, oct-passwd.h,
oct-syscalls.h, oct-time.h, oct-uname.h, pathlen.h, sysdir.h,
syswait.h, action-container.h, base-list.h, byte-swap.h,
caseless-str.h, cmd-edit.h, cmd-hist.h, data-conv.h, functor.h,
glob-match.h, lo-array-errwarn.h, lo-array-gripes.h, lo-cutils.h,
lo-ieee.h, lo-macros.h, lo-math.h, lo-regexp.h, lo-traits.h,
lo-utils.h, oct-alloc.h, oct-base64.h, oct-binmap.h, oct-cmplx.h,
oct-glob.h, oct-inttypes.h, oct-locbuf.h, oct-mutex.h, oct-refcount.h,
oct-rl-edit.h, oct-rl-hist.h, oct-shlib.h, oct-sort.h, oct-sparse.h,
pathsearch.h, singleton-cleanup.h, sparse-sort.h, sparse-util.h,
statdefs.h, str-vec.h, sun-utils.h, unwind-prot.h, url-transfer.h:
Include octave-config.h.
author | John W. Eaton <jwe@octave.org> |
---|---|
date | Wed, 10 Feb 2016 14:25:53 -0500 |
parents | 850e3d2533d4 |
children | 909129eb77c5 |
line wrap: on
line source
/* Copyright (C) 1993-2015 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_toplev_h) #define octave_toplev_h 1 #include "octave-config.h" #include <cstdio> #include <deque> #include <string> class octave_value; class octave_value_list; class octave_function; class octave_user_script; class tree_statement; class tree_statement_list; class charMatrix; #include "quit.h" #include "input.h" #include "oct-map.h" #include "symtab.h" typedef void (*octave_exit_func) (int); extern OCTINTERP_API octave_exit_func octave_exit; extern OCTINTERP_API bool quit_allowed; extern OCTINTERP_API bool quitting_gracefully; extern OCTINTERP_API int exit_status; extern OCTINTERP_API void clean_up_and_exit (int status, bool safe_to_return = false); extern OCTINTERP_API void recover_from_exception (void); extern OCTINTERP_API int main_loop (void); extern OCTINTERP_API void octave_add_atexit_function (const std::string& fname); extern OCTINTERP_API bool octave_remove_atexit_function (const std::string& fname); // TRUE means we are ready to interpret commands, but not everything // is ready for interactive use. extern OCTINTERP_API bool octave_interpreter_ready; // TRUE means we've processed all the init code and we are good to go. extern OCTINTERP_API bool octave_initialized; 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; } // 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; } // 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; } // First user-defined function on the stack. static octave_user_code *caller_user_code (size_t nskip = 0) { return instance_ok () ? instance->do_caller_user_code (nskip) : 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; int do_caller_user_code_line (void) const; int do_caller_user_code_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; 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 (); } }; // Call a function with exceptions handled to avoid problems with // errors while shutting down. #define OCTAVE_IGNORE_EXCEPTION(E) \ catch (E) \ { \ std::cerr << "error: ignoring " #E " while preparing to exit" << std::endl; \ recover_from_exception (); \ } #define OCTAVE_SAFE_CALL(F, ARGS) \ do \ { \ try \ { \ unwind_protect frame; \ \ frame.protect_var (Vdebug_on_error); \ frame.protect_var (Vdebug_on_warning); \ \ Vdebug_on_error = false; \ Vdebug_on_warning = false; \ \ F ARGS; \ } \ OCTAVE_IGNORE_EXCEPTION (const octave_interrupt_exception&) \ OCTAVE_IGNORE_EXCEPTION (const octave_execution_exception&) \ OCTAVE_IGNORE_EXCEPTION (const std::bad_alloc&) \ } \ while (0) #endif