Mercurial > octave
view libinterp/octave-value/ov-usr-fcn.h @ 20940:48b2ad5ee801
maint: Rename oct-obj.[cc|h] to ovl.[cc|h] for clarity.
* libinterp/corefcn/oct-obj.h: Replaced. Contains a #warning issued if used in
compilation and includes "ovl.h" instead. Original file renamed to
libinterp/octave-value/ovl.h
* libinterp/corefcn/oct-obj.cc: Renamed to libinterp/octave-value/ovl.cc.
* oct-obj.cc (ovl ()): Added new function to return empty octave_value_list.
* libinterp/corefcn/module.mk: Remove oct-obj.cc from build system.
* libinterp/octave-value/module.mk: Add ovl.h and ovl.cc to build system.
* mk-opts.pl, annotation-dialog.h, Cell.cc, __contourc__.cc, __dsearchn__.cc,
__lin_interpn__.cc, __pchip_deriv__.cc, __qp__.cc, balance.cc, besselj.cc,
betainc.cc, colloc.cc, conv2.cc, daspk.cc, dasrt.cc, dassl.cc, data.cc,
debug.cc, defaults.cc, defun.cc, det.cc, dirfns.cc, dlmread.cc, eig.cc,
error.cc, fft.cc, fft2.cc, fftn.cc, file-io.cc, filter.cc, find.cc,
gammainc.cc, gcd.cc, getgrent.cc, getpwent.cc, getrusage.cc, givens.cc,
graphics.cc, gripes.cc, help.cc, hess.cc, hex2num.cc, hook-fcn.h, input.cc,
input.h, inv.cc, kron.cc, load-save.cc, lookup.cc, ls-hdf5.cc, ls-mat-ascii.cc,
ls-mat4.cc, ls-mat5.cc, ls-oct-binary.cc, ls-oct-text.cc, lsode.cc, lu.cc,
luinc.cc, max.cc, mex.cc, oct-hist.cc, oct-lvalue.cc, oct-lvalue.h, oct-map.h,
oct-stream.cc, oct.h, ordschur.cc, pager.cc, pinv.cc, pr-output.cc, quad.cc,
quadcc.cc, qz.cc, rand.cc, rcond.cc, regexp.cc, schur.cc, sparse-xpow.cc,
strfns.cc, sub2ind.cc, svd.cc, sylvester.cc, symtab.h, syscalls.cc, sysdep.cc,
time.cc, toplev.cc, tril.cc, tsearch.cc, typecast.cc, urlwrite.cc, utils.cc,
variables.cc, xpow.cc, __delaunayn__.cc, __glpk__.cc, __voronoi__.cc,
audiodevinfo.cc, audioread.cc, chol.cc, convhulln.cc, dmperm.cc, qr.cc,
symbfact.cc, mkbuiltins, ov-base-diag.h, ov-base-int.cc, ov-base-mat.cc,
ov-base-mat.h, ov-base-scalar.cc, ov-base-sparse.cc, ov-base-sparse.h,
ov-base.cc, ov-bool-mat.cc, ov-bool.cc, ov-builtin.cc, ov-cell.cc, ov-colon.cc,
ov-complex.cc, ov-cs-list.h, ov-cx-mat.cc, ov-dld-fcn.cc, ov-fcn.cc, ov-fcn.h,
ov-float.cc, ov-flt-complex.cc, ov-flt-cx-mat.cc, ov-flt-re-mat.cc,
ov-int16.cc, ov-int32.cc, ov-int64.cc, ov-int8.cc, ov-java.h, ov-mex-fcn.cc,
ov-perm.h, ov-range.cc, ov-re-mat.cc, ov-scalar.cc, ov-str-mat.cc,
ov-uint16.cc, ov-uint32.cc, ov-uint64.cc, ov-uint8.cc, ov-usr-fcn.cc,
ov-usr-fcn.h, ov.cc, octave.cc, 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-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-double-conv.cc, op-fcdm-fcdm.cc,
op-fcdm-fdm.cc, op-fcm-fcm.cc, op-fcm-fcs.cc, op-fcm-fm.cc, op-fcm-fs.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-float-conv.cc, op-fm-fcm.cc, op-fm-fcs.cc, op-fm-fm.cc,
op-fm-fs.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-conv.cc, op-m-cm.cc, op-m-cs.cc, op-m-m.cc, op-m-s.cc, op-m-scm.cc,
op-m-sm.cc, op-pm-pm.cc, op-pm-scm.cc, op-pm-sm.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,
parse.h, pt-arg-list.cc, pt-assign.cc, pt-binop.cc, pt-cbinop.cc, pt-cell.cc,
pt-colon.cc, pt-const.cc, pt-eval.h, pt-fcn-handle.cc, pt-funcall.h, pt-id.cc,
pt-idx.cc, pt-jump.cc, pt-mat.cc, pt-select.cc, pt-unop.cc, token.cc,
Array-sym.cc: replace '#include "oct-obj.h"' with '#include "ovl.h"'.
author | Rik <rik@octave.org> |
---|---|
date | Fri, 18 Dec 2015 16:04:56 -0800 |
parents | f7084eae3318 |
children | 93748bcaec17 |
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 <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 = std::string ()) : 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 = std::string ()); octave_user_script (const std::string& fnm, const std::string& nm, const std::string& ds = std::string ()); ~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 = std::string ()) { 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 = std::string ()) 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 = std::string ()) const { return class_constructor == legacy ? (cname.empty () ? true : cname == dispatch_class ()) : false; } bool is_classdef_constructor (const std::string& cname = std::string ()) 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 = std::string ()) 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 <class 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