Mercurial > octave
view libinterp/octave-value/ov-usr-fcn.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 | 538b57866b90 |
children | aba2e6293dd8 |
line wrap: on
line source
/* Copyright (C) 1996-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_ov_usr_fcn_h) #define octave_ov_usr_fcn_h 1 #include "octave-config.h" #include <ctime> #include <string> #include <stack> #include "comment-list.h" #include "ovl.h" #include "ov-fcn.h" #include "ov-typeinfo.h" #include "symtab.h" #include "unwind-prot.h" class string_vector; class octave_value; class tree_parameter_list; class tree_statement_list; class tree_va_return_list; class tree_expression; class tree_walker; #ifdef HAVE_LLVM class jit_function_info; #endif class octave_user_code : public octave_function { public: octave_user_code (void) : octave_function () { } ~octave_user_code (void) { } bool is_user_code (void) const { return true; } virtual std::map<std::string, octave_value> subfunctions (void) const; virtual tree_statement_list *body (void) = 0; protected: octave_user_code (const std::string& nm, const std::string& ds = "") : octave_function (nm, ds) { } private: // No copying! octave_user_code (const octave_user_code& f); octave_user_code& operator = (const octave_user_code& f); }; // Scripts. class octave_user_script : public octave_user_code { public: octave_user_script (void); octave_user_script (const std::string& fnm, const std::string& nm, tree_statement_list *cmds, const std::string& ds = ""); octave_user_script (const std::string& fnm, const std::string& nm, const std::string& ds = ""); ~octave_user_script (void); octave_function *function_value (bool = false) { return this; } octave_user_script *user_script_value (bool = false) { return this; } octave_user_code *user_code_value (bool = false) { return this; } // Scripts and user functions are both considered "scripts" because // they are written in Octave's scripting language. bool is_user_script (void) const { return true; } void stash_fcn_file_name (const std::string& nm) { file_name = nm; } void mark_fcn_file_up_to_date (const octave_time& t) { t_checked = t; } void stash_fcn_file_time (const octave_time& t) { t_parsed = t; mark_fcn_file_up_to_date (t); } std::string fcn_file_name (void) const { return file_name; } octave_time time_parsed (void) const { return t_parsed; } octave_time time_checked (void) const { return t_checked; } octave_value subsref (const std::string& type, const std::list<octave_value_list>& idx) { octave_value_list tmp = subsref (type, idx, 1); return tmp.length () > 0 ? tmp(0) : octave_value (); } octave_value_list subsref (const std::string& type, const std::list<octave_value_list>& idx, int nargout); octave_value_list do_multi_index_op (int nargout, const octave_value_list& args); tree_statement_list *body (void) { return cmd_list; } void accept (tree_walker& tw); private: // The list of commands that make up the body of this function. tree_statement_list *cmd_list; // The name of the file we parsed. std::string file_name; // The time the file was parsed. octave_time t_parsed; // The time the file was last checked to see if it needs to be // parsed again. octave_time t_checked; // Used to keep track of recursion depth. int call_depth; // No copying! octave_user_script (const octave_user_script& f); octave_user_script& operator = (const octave_user_script& f); DECLARE_OV_TYPEID_FUNCTIONS_AND_DATA }; // User-defined functions. class octave_user_function : public octave_user_code { public: octave_user_function (symbol_table::scope_id sid = -1, tree_parameter_list *pl = 0, tree_parameter_list *rl = 0, tree_statement_list *cl = 0); ~octave_user_function (void); symbol_table::context_id active_context () const { return is_anonymous_function () ? 0 : static_cast<symbol_table::context_id>(call_depth); } octave_function *function_value (bool = false) { return this; } octave_user_function *user_function_value (bool = false) { return this; } octave_user_code *user_code_value (bool = false) { return this; } octave_user_function *define_param_list (tree_parameter_list *t); octave_user_function *define_ret_list (tree_parameter_list *t); void stash_fcn_file_name (const std::string& nm); void stash_fcn_location (int line, int col) { location_line = line; location_column = col; } int beginning_line (void) const { return location_line; } int beginning_column (void) const { return location_column; } void stash_fcn_end_location (int line, int col) { end_location_line = line; end_location_column = col; } int ending_line (void) const { return end_location_line; } int ending_column (void) const { return end_location_column; } void maybe_relocate_end (void); void stash_parent_fcn_name (const std::string& p) { parent_name = p; } void stash_parent_fcn_scope (symbol_table::scope_id ps) { parent_scope = ps; } void stash_leading_comment (octave_comment_list *lc) { lead_comm = lc; } void stash_trailing_comment (octave_comment_list *tc) { trail_comm = tc; } void mark_fcn_file_up_to_date (const octave_time& t) { t_checked = t; } void stash_fcn_file_time (const octave_time& t) { t_parsed = t; mark_fcn_file_up_to_date (t); } std::string fcn_file_name (void) const { return file_name; } std::string profiler_name (void) const; std::string parent_fcn_name (void) const { return parent_name; } symbol_table::scope_id parent_fcn_scope (void) const { return parent_scope; } symbol_table::scope_id scope (void) { return local_scope; } octave_time time_parsed (void) const { return t_parsed; } octave_time time_checked (void) const { return t_checked; } void mark_as_system_fcn_file (void); bool is_system_fcn_file (void) const { return system_fcn_file; } bool is_user_function (void) const { return true; } void erase_subfunctions (void) { symbol_table::erase_subfunctions_in_scope (local_scope); } bool takes_varargs (void) const; bool takes_var_return (void) const; void mark_as_private_function (const std::string& cname = "") { symbol_table::mark_subfunctions_in_scope_as_private (local_scope, cname); octave_function::mark_as_private_function (cname); } void lock_subfunctions (void); void unlock_subfunctions (void); std::map<std::string, octave_value> subfunctions (void) const; bool has_subfunctions (void) const; void stash_subfunction_names (const std::list<std::string>& names); std::list<std::string> subfunction_names (void) const { return subfcn_names; } octave_value_list all_va_args (const octave_value_list& args); void stash_function_name (const std::string& s) { my_name = s; } void mark_as_subfunction (void) { subfunction = true; } bool is_subfunction (void) const { return subfunction; } void mark_as_inline_function (void) { inline_function = true; } bool is_inline_function (void) const { return inline_function; } void mark_as_anonymous_function (void) { anonymous_function = true; } bool is_anonymous_function (void) const { return anonymous_function; } bool is_anonymous_function_of_class (const std::string& cname = "") const { return anonymous_function ? (cname.empty () ? (! dispatch_class ().empty ()) : cname == dispatch_class ()) : false; } // If we are a special expression, then the function body consists of exactly // one expression. The expression's result is the return value of the // function. bool is_special_expr (void) const { return is_inline_function () || is_anonymous_function (); } bool is_nested_function (void) const { return nested_function; } void mark_as_nested_function (void) { nested_function = true; } void mark_as_class_constructor (void) { class_constructor = legacy; } void mark_as_classdef_constructor (void) { class_constructor = classdef; } bool is_class_constructor (const std::string& cname = "") const { return class_constructor == legacy ? (cname.empty () ? true : cname == dispatch_class ()) : false; } bool is_classdef_constructor (const std::string& cname = "") const { return class_constructor == classdef ? (cname.empty () ? true : cname == dispatch_class ()) : false; } void mark_as_class_method (void) { class_method = true; } bool is_class_method (const std::string& cname = "") const { return class_method ? (cname.empty () ? true : cname == dispatch_class ()) : false; } octave_value subsref (const std::string& type, const std::list<octave_value_list>& idx) { octave_value_list tmp = subsref (type, idx, 1); return tmp.length () > 0 ? tmp(0) : octave_value (); } octave_value_list subsref (const std::string& type, const std::list<octave_value_list>& idx, int nargout); octave_value_list subsref (const std::string& type, const std::list<octave_value_list>& idx, int nargout, const std::list<octave_lvalue>* lvalue_list); octave_value_list do_multi_index_op (int nargout, const octave_value_list& args); octave_value_list do_multi_index_op (int nargout, const octave_value_list& args, const std::list<octave_lvalue>* lvalue_list); tree_parameter_list *parameter_list (void) { return param_list; } tree_parameter_list *return_list (void) { return ret_list; } tree_statement_list *body (void) { return cmd_list; } octave_comment_list *leading_comment (void) { return lead_comm; } octave_comment_list *trailing_comment (void) { return trail_comm; } // If is_special_expr is true, retrieve the sigular expression that forms the // body. May be null (even if is_special_expr is true). tree_expression *special_expr (void); bool subsasgn_optimization_ok (void); void accept (tree_walker& tw); template <typename T> bool local_protect (T& variable) { if (curr_unwind_protect_frame) { curr_unwind_protect_frame->protect_var (variable); return true; } else return false; } #ifdef HAVE_LLVM jit_function_info *get_info (void) { return jit_info; } void stash_info (jit_function_info *info) { jit_info = info; } #endif #if 0 void print_symtab_info (std::ostream& os) const; #endif private: enum class_ctor_type { none, legacy, classdef }; // List of arguments for this function. These are local variables. tree_parameter_list *param_list; // List of parameters we return. These are also local variables in // this function. tree_parameter_list *ret_list; // The list of commands that make up the body of this function. tree_statement_list *cmd_list; // The comments preceding the FUNCTION token. octave_comment_list *lead_comm; // The comments preceding the ENDFUNCTION token. octave_comment_list *trail_comm; // The name of the file we parsed. std::string file_name; // Location where this function was defined. int location_line; int location_column; int end_location_line; int end_location_column; // The name of the parent function, if any. std::string parent_name; // The list of subfunctions (if any) in the order they appear in the // file. std::list<std::string> subfcn_names; // The time the file was parsed. octave_time t_parsed; // The time the file was last checked to see if it needs to be // parsed again. octave_time t_checked; // True if this function came from a file that is considered to be a // system function. This affects whether we check the time stamp // on the file to see if it has changed. bool system_fcn_file; // Used to keep track of recursion depth. int call_depth; // The number of arguments that have names. int num_named_args; // TRUE means this subfunction of a primary function. bool subfunction; // TRUE means this is an inline function. bool inline_function; // TRUE means this is an anonymous function. bool anonymous_function; // TRUE means this is a nested function. (either a child or parent) bool nested_function; // Enum describing whether this function is the constructor for class object. class_ctor_type class_constructor; // TRUE means this function is a method for a class. bool class_method; // The scope of the parent function, if any. symbol_table::scope_id parent_scope; symbol_table::scope_id local_scope; // pointer to the current unwind_protect frame of this function. unwind_protect *curr_unwind_protect_frame; #ifdef HAVE_LLVM jit_function_info *jit_info; #endif void maybe_relocate_end_internal (void); void print_code_function_header (void); void print_code_function_trailer (void); void bind_automatic_vars (const string_vector& arg_names, int nargin, int nargout, const octave_value_list& va_args, const std::list<octave_lvalue> *lvalue_list); void restore_warning_states (void); // No copying! octave_user_function (const octave_user_function& fn); octave_user_function& operator = (const octave_user_function& fn); DECLARE_OV_TYPEID_FUNCTIONS_AND_DATA }; #endif