Mercurial > octave
view libinterp/octave-value/ov-usr-fcn.h @ 31605:e88a07dec498 stable
maint: Use macros to begin/end C++ namespaces.
* oct-conf-post-public.in.h: Define two macros (OCTAVE_BEGIN_NAMESPACE,
OCTAVE_END_NAMESPACE) that can be used to start/end a namespace.
* mk-opts.pl, build-env.h, build-env.in.cc, __betainc__.cc, __contourc__.cc,
__dsearchn__.cc, __eigs__.cc, __expint__.cc, __ftp__.cc, __gammainc__.cc,
__ichol__.cc, __ilu__.cc, __isprimelarge__.cc, __lin_interpn__.cc,
__magick_read__.cc, __pchip_deriv__.cc, __qp__.cc, amd.cc, auto-shlib.cc,
auto-shlib.h, balance.cc, base-text-renderer.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, ccolamd.cc, cellfun.cc, chol.cc, colamd.cc,
colloc.cc, conv2.cc, daspk.cc, dasrt.cc, dassl.cc, data.cc, data.h, debug.cc,
defaults.cc, defaults.h, defun-int.h, defun.cc, det.cc, dirfns.cc, display.cc,
display.h, dlmread.cc, dmperm.cc, dot.cc, dynamic-ld.cc, dynamic-ld.h, eig.cc,
ellipj.cc, environment.cc, environment.h, error.cc, error.h, errwarn.h,
event-manager.cc, event-manager.h, event-queue.cc, event-queue.h, fcn-info.cc,
fcn-info.h, fft.cc, fft2.cc, fftn.cc, file-io.cc, filter.cc, find.cc,
ft-text-renderer.cc, ft-text-renderer.h, gcd.cc, getgrent.cc, getpwent.cc,
getrusage.cc, givens.cc, gl-render.cc, gl-render.h, gl2ps-print.cc,
gl2ps-print.h, graphics-toolkit.cc, graphics-toolkit.h, graphics.cc,
graphics.in.h, gsvd.cc, gtk-manager.cc, gtk-manager.h, hash.cc, help.cc,
help.h, hess.cc, hex2num.cc, hook-fcn.cc, hook-fcn.h, input.cc, input.h,
interpreter-private.cc, interpreter-private.h, interpreter.cc, interpreter.h,
inv.cc, jsondecode.cc, jsonencode.cc, kron.cc, latex-text-renderer.cc,
latex-text-renderer.h, load-path.cc, load-path.h, load-save.cc, load-save.h,
lookup.cc, ls-ascii-helper.cc, ls-ascii-helper.h, ls-oct-text.cc, ls-utils.cc,
ls-utils.h, lsode.cc, lu.cc, mappers.cc, matrix_type.cc, max.cc, mex-private.h,
mex.cc, mgorth.cc, nproc.cc, oct-fstrm.cc, oct-fstrm.h, oct-hdf5-types.cc,
oct-hdf5-types.h, oct-hist.cc, oct-hist.h, oct-iostrm.cc, oct-iostrm.h,
oct-opengl.h, oct-prcstrm.cc, oct-prcstrm.h, oct-procbuf.cc, oct-procbuf.h,
oct-process.cc, oct-process.h, oct-stdstrm.h, oct-stream.cc, oct-stream.h,
oct-strstrm.cc, oct-strstrm.h, oct-tex-lexer.in.ll, oct-tex-parser.yy,
ordqz.cc, ordschur.cc, pager.cc, pager.h, pinv.cc, pow2.cc, pr-flt-fmt.cc,
pr-output.cc, procstream.cc, procstream.h, psi.cc, qr.cc, quad.cc, quadcc.cc,
qz.cc, rand.cc, rcond.cc, regexp.cc, schur.cc, settings.cc, settings.h,
sighandlers.cc, sighandlers.h, sparse-xdiv.cc, sparse-xdiv.h, sparse-xpow.cc,
sparse-xpow.h, sparse.cc, spparms.cc, sqrtm.cc, stack-frame.cc, stack-frame.h,
stream-euler.cc, strfind.cc, strfns.cc, sub2ind.cc, svd.cc, sylvester.cc,
symbfact.cc, syminfo.cc, syminfo.h, symrcm.cc, symrec.cc, symrec.h,
symscope.cc, symscope.h, symtab.cc, symtab.h, syscalls.cc, sysdep.cc, sysdep.h,
text-engine.cc, text-engine.h, text-renderer.cc, text-renderer.h, time.cc,
toplev.cc, tril.cc, tsearch.cc, typecast.cc, url-handle-manager.cc,
url-handle-manager.h, urlwrite.cc, utils.cc, utils.h, variables.cc,
variables.h, xdiv.cc, xdiv.h, xnorm.cc, xnorm.h, xpow.cc, xpow.h,
__delaunayn__.cc, __fltk_uigetfile__.cc, __glpk__.cc, __init_fltk__.cc,
__init_gnuplot__.cc, __ode15__.cc, __voronoi__.cc, audiodevinfo.cc,
audioread.cc, convhulln.cc, fftw.cc, gzip.cc, mk-build-env-features.sh,
mk-builtins.pl, cdef-class.cc, cdef-class.h, cdef-fwd.h, cdef-manager.cc,
cdef-manager.h, cdef-method.cc, cdef-method.h, cdef-object.cc, cdef-object.h,
cdef-package.cc, cdef-package.h, cdef-property.cc, cdef-property.h,
cdef-utils.cc, cdef-utils.h, ov-base.cc, ov-base.h, ov-bool-mat.cc,
ov-builtin.h, ov-cell.cc, ov-class.cc, ov-class.h, ov-classdef.cc,
ov-classdef.h, ov-complex.cc, ov-fcn-handle.cc, ov-fcn-handle.h, ov-fcn.h,
ov-java.cc, ov-java.h, ov-mex-fcn.h, ov-null-mat.cc, ov-oncleanup.cc,
ov-struct.cc, ov-typeinfo.cc, ov-typeinfo.h, ov-usr-fcn.cc, ov-usr-fcn.h,
ov.cc, ov.h, octave.cc, octave.h, mk-ops.sh, 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-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-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-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-m-cm.cc, op-m-cs.cc, op-m-m.cc, op-m-s.cc,
op-m-scm.cc, op-m-sm.cc, op-mi.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,
anon-fcn-validator.cc, anon-fcn-validator.h, bp-table.cc, bp-table.h,
comment-list.cc, comment-list.h, filepos.h, lex.h, lex.ll, oct-lvalue.cc,
oct-lvalue.h, oct-parse.yy, parse.h, profiler.cc, profiler.h,
pt-anon-scopes.cc, pt-anon-scopes.h, pt-arg-list.cc, pt-arg-list.h,
pt-args-block.cc, pt-args-block.h, pt-array-list.cc, 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.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-id.cc,
pt-id.h, pt-idx.cc, pt-idx.h, 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-spmd.cc, pt-spmd.h, pt-stmt.cc, pt-stmt.h, pt-tm-const.cc,
pt-tm-const.h, pt-unop.cc, pt-unop.h, pt-vm-eval.cc, pt-walk.cc, pt-walk.h,
pt.cc, pt.h, token.cc, token.h, Range.cc, Range.h, idx-vector.cc, idx-vector.h,
range-fwd.h, CollocWt.cc, CollocWt.h, aepbalance.cc, aepbalance.h, chol.cc,
chol.h, gepbalance.cc, gepbalance.h, gsvd.cc, gsvd.h, hess.cc, hess.h,
lo-mappers.cc, lo-mappers.h, lo-specfun.cc, lo-specfun.h, lu.cc, lu.h,
oct-convn.cc, oct-convn.h, oct-fftw.cc, oct-fftw.h, oct-norm.cc, oct-norm.h,
oct-rand.cc, oct-rand.h, oct-spparms.cc, oct-spparms.h, qr.cc, qr.h, qrp.cc,
qrp.h, randgamma.cc, randgamma.h, randmtzig.cc, randmtzig.h, randpoisson.cc,
randpoisson.h, schur.cc, schur.h, sparse-chol.cc, sparse-chol.h, sparse-lu.cc,
sparse-lu.h, sparse-qr.cc, sparse-qr.h, svd.cc, svd.h, child-list.cc,
child-list.h, dir-ops.cc, dir-ops.h, file-ops.cc, file-ops.h, file-stat.cc,
file-stat.h, lo-sysdep.cc, lo-sysdep.h, lo-sysinfo.cc, lo-sysinfo.h,
mach-info.cc, mach-info.h, oct-env.cc, oct-env.h, oct-group.cc, oct-group.h,
oct-password.cc, oct-password.h, oct-syscalls.cc, oct-syscalls.h, oct-time.cc,
oct-time.h, oct-uname.cc, oct-uname.h, action-container.cc, action-container.h,
base-list.h, cmd-edit.cc, cmd-edit.h, cmd-hist.cc, cmd-hist.h, f77-fcn.h,
file-info.cc, file-info.h, lo-array-errwarn.cc, lo-array-errwarn.h, lo-hash.cc,
lo-hash.h, lo-ieee.h, lo-regexp.cc, lo-regexp.h, lo-utils.cc, lo-utils.h,
oct-base64.cc, oct-base64.h, oct-glob.cc, oct-glob.h, oct-inttypes.h,
oct-mutex.cc, oct-mutex.h, oct-refcount.h, oct-shlib.cc, oct-shlib.h,
oct-sparse.cc, oct-sparse.h, oct-string.h, octave-preserve-stream-state.h,
pathsearch.cc, pathsearch.h, quit.cc, quit.h, unwind-prot.cc, unwind-prot.h,
url-transfer.cc, url-transfer.h : Use new macros to begin/end C++ namespaces.
author | Rik <rik@octave.org> |
---|---|
date | Thu, 01 Dec 2022 14:23:45 -0800 |
parents | c9788d7f6e65 |
children | aac27ad79be6 |
line wrap: on
line source
//////////////////////////////////////////////////////////////////////// // // Copyright (C) 1996-2022 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_ov_usr_fcn_h) #define octave_ov_usr_fcn_h 1 #include "octave-config.h" #include <string> #include "comment-list.h" #include "ovl.h" #include "ov-fcn.h" #include "ov-typeinfo.h" #include "symscope.h" #include "unwind-prot.h" class string_vector; class octave_value; OCTAVE_BEGIN_NAMESPACE(octave) class file_info; class stack_frame; class tree_parameter_list; class tree_statement_list; class tree_evaluator; class tree_expression; class tree_walker; OCTAVE_END_NAMESPACE(octave) class octave_user_code : public octave_function { protected: octave_user_code (const std::string& fnm = "", const std::string& nm = "", const octave::symbol_scope& scope = octave::symbol_scope (), octave::tree_statement_list *cmds = nullptr, const std::string& ds = "") : octave_function (nm, ds), m_scope (scope), m_file_name (fnm), m_t_parsed (static_cast<OCTAVE_TIME_T> (0)), m_t_checked (static_cast<OCTAVE_TIME_T> (0)), m_file_info (nullptr), m_cmd_list (cmds) { if (m_scope) m_scope.set_user_code (this); } public: // No copying! octave_user_code (const octave_user_code& f) = delete; octave_user_code& operator = (const octave_user_code& f) = delete; ~octave_user_code (void); bool is_user_code (void) const { return true; } std::string get_code_line (std::size_t line); std::deque<std::string> get_code_lines (std::size_t line, std::size_t num_lines); void cache_function_text (const std::string& text, const octave::sys::time& timestamp); octave::symbol_scope scope (void) { return m_scope; } void stash_fcn_file_name (const std::string& nm) { m_file_name = nm; } void mark_fcn_file_up_to_date (const octave::sys::time& t) { m_t_checked = t; } void stash_fcn_file_time (const octave::sys::time& t) { m_t_parsed = t; mark_fcn_file_up_to_date (t); } std::string fcn_file_name (void) const { return m_file_name; } octave::sys::time time_parsed (void) const { return m_t_parsed; } octave::sys::time time_checked (void) const { return m_t_checked; } virtual octave_value find_subfunction (const std::string&) const { return octave_value (); } virtual std::map<std::string, octave_value> subfunctions (void) const; octave::tree_statement_list * body (void) { return m_cmd_list; } octave_value dump (void) const; protected: void get_file_info (void); // Our symbol table scope. octave::symbol_scope m_scope; // The name of the file we parsed. std::string m_file_name; // The time the file was parsed. octave::sys::time m_t_parsed; // The time the file was last checked to see if it needs to be // parsed again. octave::sys::time m_t_checked; // Cached text of function or script code with line offsets // calculated. octave::file_info *m_file_info; // The list of commands that make up the body of this function. octave::tree_statement_list *m_cmd_list; }; // 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, const octave::symbol_scope& scope = octave::symbol_scope (), octave::tree_statement_list *cmds = nullptr, const std::string& ds = ""); octave_user_script (const std::string& fnm, const std::string& nm, const octave::symbol_scope& scope = octave::symbol_scope (), const std::string& ds = ""); // No copying! octave_user_script (const octave_user_script& f) = delete; octave_user_script& operator = (const octave_user_script& f) = delete; ~octave_user_script (void) = default; 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; } // We must overload the call method so that we call the proper // push_stack_frame method, which is overloaded for pointers to // octave_function, octave_user_function, and octave_user_script // objects. octave_value_list call (octave::tree_evaluator& tw, int nargout = 0, const octave_value_list& args = octave_value_list ()); octave_value_list execute (octave::tree_evaluator& tw, int nargout = 0, const octave_value_list& args = octave_value_list ()); void accept (octave::tree_walker& tw); private: DECLARE_OV_TYPEID_FUNCTIONS_AND_DATA }; // User-defined functions. class octave_user_function : public octave_user_code { public: octave_user_function (const octave::symbol_scope& scope = octave::symbol_scope (), octave::tree_parameter_list *pl = nullptr, octave::tree_parameter_list *rl = nullptr, octave::tree_statement_list *cl = nullptr); // No copying! octave_user_function (const octave_user_function& fcn) = delete; octave_user_function& operator = (const octave_user_function& fcn) = delete; ~octave_user_function (void); 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 (octave::tree_parameter_list *t); octave_user_function * define_ret_list (octave::tree_parameter_list *t); void stash_fcn_location (int line, int col) { m_location_line = line; m_location_column = col; } int beginning_line (void) const { return m_location_line; } int beginning_column (void) const { return m_location_column; } void stash_fcn_end_location (int line, int col) { m_end_location_line = line; m_end_location_column = col; } int ending_line (void) const { return m_end_location_line; } int ending_column (void) const { return m_end_location_column; } void maybe_relocate_end (void); void stash_parent_fcn_scope (const octave::symbol_scope& ps); void stash_leading_comment (octave::comment_list *lc) { m_lead_comm = lc; } void stash_trailing_comment (octave::comment_list *tc) { m_trail_comm = tc; } std::string profiler_name (void) const; std::string parent_fcn_name (void) const { octave::symbol_scope pscope = parent_fcn_scope (); return pscope.fcn_name (); } octave::symbol_scope parent_fcn_scope (void) const { return m_scope.parent_scope (); } std::list<std::string> parent_fcn_names (void) const { return m_scope.parent_fcn_names (); } void mark_as_system_fcn_file (void); bool is_system_fcn_file (void) const { return m_system_fcn_file; } bool is_user_function (void) const { return true; } void erase_subfunctions (void); bool takes_varargs (void) const; bool takes_var_return (void) const; void mark_as_private_function (const std::string& cname = ""); void lock_subfunctions (void); void unlock_subfunctions (void); std::map<std::string, octave_value> subfunctions (void) const; octave_value find_subfunction (const std::string& subfuns) const; bool has_subfunctions (void) const; void stash_subfunction_names (const std::list<std::string>& names); std::list<std::string> subfunction_names (void) const; octave_value_list all_va_args (const octave_value_list& args); void stash_function_name (const std::string& s) { m_name = s; } void mark_as_subfunction (void) { m_subfunction = true; } bool is_subfunction (void) const { return m_subfunction; } void mark_as_inline_function (void) { m_inline_function = true; } bool is_inline_function (void) const { return m_inline_function; } void mark_as_anonymous_function (void) { m_anonymous_function = true; } bool is_anonymous_function (void) const { return m_anonymous_function; } bool is_anonymous_function_of_class (const std::string& cname = "") const { return m_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 (); } void mark_as_nested_function (void) { m_nested_function = true; } bool is_nested_function (void) const { return m_nested_function; } bool is_parent_function (void) const { return m_scope.is_parent (); } void mark_as_legacy_constructor (void) { m_class_constructor = legacy; } bool is_legacy_constructor (const std::string& cname = "") const { return (m_class_constructor == legacy ? (cname.empty () ? true : cname == dispatch_class ()) : false); } void mark_as_classdef_constructor (void) { m_class_constructor = classdef; } bool is_classdef_constructor (const std::string& cname = "") const { return (m_class_constructor == classdef ? (cname.empty () ? true : cname == dispatch_class ()) : false); } void mark_as_legacy_method (void) { m_class_method = legacy; } bool is_legacy_method (const std::string& cname = "") const { return (m_class_method == legacy ? (cname.empty () ? true : cname == dispatch_class ()) : false); } void mark_as_classdef_method (void) { m_class_method = classdef; } bool is_classdef_method (const std::string& cname = "") const { return (m_class_method == classdef ? (cname.empty () ? true : cname == dispatch_class ()) : false); } // We must overload the call method so that we call the proper // push_stack_frame method, which is overloaded for pointers to // octave_function, octave_user_function, and octave_user_script // objects. octave_value_list call (octave::tree_evaluator& tw, int nargout = 0, const octave_value_list& args = octave_value_list ()); octave_value_list execute (octave::tree_evaluator& tw, int nargout = 0, const octave_value_list& args = octave_value_list ()); octave::tree_parameter_list * parameter_list (void) { return m_param_list; } octave::tree_parameter_list * return_list (void) { return m_ret_list; } octave::comment_list * leading_comment (void) { return m_lead_comm; } octave::comment_list * trailing_comment (void) { return m_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). octave::tree_expression * special_expr (void); bool subsasgn_optimization_ok (void); void accept (octave::tree_walker& tw); octave_value dump (void) const; private: enum class_method_type { none, legacy, classdef }; std::string ctor_type_str (void) const; std::string method_type_str (void) const; // List of arguments for this function. These are local variables. octave::tree_parameter_list *m_param_list; // List of parameters we return. These are also local variables in // this function. octave::tree_parameter_list *m_ret_list; // The comments preceding the FUNCTION token. octave::comment_list *m_lead_comm; // The comments preceding the ENDFUNCTION token. octave::comment_list *m_trail_comm; // Location where this function was defined. int m_location_line; int m_location_column; int m_end_location_line; int m_end_location_column; // 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 m_system_fcn_file; // The number of arguments that have names. int m_num_named_args; // TRUE means this is a m_subfunction of a primary function. bool m_subfunction; // TRUE means this is an inline function. bool m_inline_function; // TRUE means this is an anonymous function. bool m_anonymous_function; // TRUE means this is a nested function. bool m_nested_function; // Enum describing whether this function is the constructor for class object. class_method_type m_class_constructor; // Enum describing whether this function is a method for a class. class_method_type m_class_method; void maybe_relocate_end_internal (void); void print_code_function_header (const std::string& prefix); void print_code_function_trailer (const std::string& prefix); // XXX FIXME (public) public: void restore_warning_states (void); DECLARE_OV_TYPEID_FUNCTIONS_AND_DATA }; #endif