octave-lyh: src/ov-usr-fcn.cc annotate

annotate src/ov-usr-fcn.cc @ 14136:20cb178716ee

Make nargin and nargout behave more like Matlab's (Bug #32700) * ov-usr-fcn.cc: Include "ov-fcn-handle.h". (Fnargout, Fnargin) nargout can be given a function handle as well as a string. Allow nargout(fcn) works in the top level. Make inline functions always return 1. Make anonymous functions always return -1. Make functions with varargout optionally preceded by named outputs return -(length_output_list_including_the_varargout).

author	Iain Murray <iain@iainmurray.net>
date	Mon, 02 Jan 2012 12:49:52 -0500
parents	7a5aacf65f81
children	a74954d70c18

rev	line source
2974 ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	1 /*
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	2
11523 fd0a3ac60b0e update copyright notices John W. Eaton <jwe@octave.org> parents: 11461 diff changeset	3 Copyright (C) 1996-2011 John W. Eaton
2974 ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	4
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	5 This file is part of Octave.
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	6
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	7 Octave is free software; you can redistribute it and/or modify it
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	8 under the terms of the GNU General Public License as published by the
7016 93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6657 diff changeset	9 Free Software Foundation; either version 3 of the License, or (at your
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6657 diff changeset	10 option) any later version.
2974 ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	11
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	12 Octave is distributed in the hope that it will be useful, but WITHOUT
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	15 for more details.
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	16
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	17 You should have received a copy of the GNU General Public License
7016 93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6657 diff changeset	18 along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6657 diff changeset	19 <http://www.gnu.org/licenses/>.
2974 ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	20
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	21 */
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	22
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	23 #ifdef HAVE_CONFIG_H
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	24 #include <config.h>
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	25 #endif
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	26
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	27 #include "str-vec.h"
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	28
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	29 #include <defaults.h>
3974 e2290bf911f0 [project @ 2002-07-04 17:38:22 by jwe] jwe parents: 3933 diff changeset	30 #include "Cell.h"
2974 ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	31 #include "defun.h"
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	32 #include "error.h"
10832 1b2fcd122c6a allow user detect ignored outputs in m-functions Jaroslav Hajek <highegg@gmail.com> parents: 10637 diff changeset	33 #include "gripes.h"
2974 ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	34 #include "input.h"
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	35 #include "oct-obj.h"
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	36 #include "ov-usr-fcn.h"
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	37 #include "ov.h"
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	38 #include "pager.h"
8658 73c4516fae10 New evaluator and debugger derived from tree-walker class John W. Eaton <jwe@octave.org> parents: 8580 diff changeset	39 #include "pt-eval.h"
2985 aa9d0c0e0458 [project @ 1997-05-16 06:54:18 by jwe] jwe parents: 2982 diff changeset	40 #include "pt-jump.h"
2974 ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	41 #include "pt-misc.h"
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	42 #include "pt-pr-code.h"
2982 20f5cec4f11c [project @ 1997-05-16 03:29:26 by jwe] jwe parents: 2974 diff changeset	43 #include "pt-stmt.h"
2974 ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	44 #include "pt-walk.h"
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	45 #include "symtab.h"
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	46 #include "toplev.h"
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	47 #include "unwind-prot.h"
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	48 #include "utils.h"
3489 cbee5fbb696d [project @ 2000-01-28 09:14:32 by jwe] jwe parents: 3445 diff changeset	49 #include "parse.h"
2974 ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	50 #include "variables.h"
14136 20cb178716ee Make nargin and nargout behave more like Matlab's (Bug #32700) Iain Murray <iain@iainmurray.net> parents: 12483 diff changeset	51 #include "ov-fcn-handle.h"
2974 ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	52
9522 e79470be3ecb implement subsasgn this-arg optimization Jaroslav Hajek <highegg@gmail.com> parents: 9396 diff changeset	53 // Whether to optimize subsasgn method calls.
9529 8e5009334661 partially revert e79470be3ecb Jaroslav Hajek <highegg@gmail.com> parents: 9522 diff changeset	54 static bool Voptimize_subsasgn_calls = true;
9522 e79470be3ecb implement subsasgn this-arg optimization Jaroslav Hajek <highegg@gmail.com> parents: 9396 diff changeset	55
7715 5b4d278ec828 parse scripts completely before executing John W. Eaton <jwe@octave.org> parents: 7589 diff changeset	56 // User defined scripts.
5b4d278ec828 parse scripts completely before executing John W. Eaton <jwe@octave.org> parents: 7589 diff changeset	57
5b4d278ec828 parse scripts completely before executing John W. Eaton <jwe@octave.org> parents: 7589 diff changeset	58 DEFINE_OCTAVE_ALLOCATOR (octave_user_script);
5b4d278ec828 parse scripts completely before executing John W. Eaton <jwe@octave.org> parents: 7589 diff changeset	59
5b4d278ec828 parse scripts completely before executing John W. Eaton <jwe@octave.org> parents: 7589 diff changeset	60 DEFINE_OV_TYPEID_FUNCTIONS_AND_DATA (octave_user_script,
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	61 "user-defined script",
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	62 "user-defined script");
7715 5b4d278ec828 parse scripts completely before executing John W. Eaton <jwe@octave.org> parents: 7589 diff changeset	63
7731 2d2a969c731c fix max_recursion_limit exceeded at startup with Intel C++ Jaroslav Hajek <highegg@gmail.com> parents: 7719 diff changeset	64 octave_user_script::octave_user_script (void)
2d2a969c731c fix max_recursion_limit exceeded at startup with Intel C++ Jaroslav Hajek <highegg@gmail.com> parents: 7719 diff changeset	65 : octave_user_code (), cmd_list (0), file_name (),
2d2a969c731c fix max_recursion_limit exceeded at startup with Intel C++ Jaroslav Hajek <highegg@gmail.com> parents: 7719 diff changeset	66 t_parsed (static_cast<time_t> (0)),
2d2a969c731c fix max_recursion_limit exceeded at startup with Intel C++ Jaroslav Hajek <highegg@gmail.com> parents: 7719 diff changeset	67 t_checked (static_cast<time_t> (0)),
7752 40c428ea3408 initial implementation of dbup and dbdown John W. Eaton <jwe@octave.org> parents: 7736 diff changeset	68 call_depth (-1)
7731 2d2a969c731c fix max_recursion_limit exceeded at startup with Intel C++ Jaroslav Hajek <highegg@gmail.com> parents: 7719 diff changeset	69 { }
2d2a969c731c fix max_recursion_limit exceeded at startup with Intel C++ Jaroslav Hajek <highegg@gmail.com> parents: 7719 diff changeset	70
2d2a969c731c fix max_recursion_limit exceeded at startup with Intel C++ Jaroslav Hajek <highegg@gmail.com> parents: 7719 diff changeset	71 octave_user_script::octave_user_script (const std::string& fnm,
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	72 const std::string& nm,
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	73 tree_statement_list *cmds,
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	74 const std::string& ds)
7731 2d2a969c731c fix max_recursion_limit exceeded at startup with Intel C++ Jaroslav Hajek <highegg@gmail.com> parents: 7719 diff changeset	75 : octave_user_code (nm, ds), cmd_list (cmds), file_name (fnm),
2d2a969c731c fix max_recursion_limit exceeded at startup with Intel C++ Jaroslav Hajek <highegg@gmail.com> parents: 7719 diff changeset	76 t_parsed (static_cast<time_t> (0)),
2d2a969c731c fix max_recursion_limit exceeded at startup with Intel C++ Jaroslav Hajek <highegg@gmail.com> parents: 7719 diff changeset	77 t_checked (static_cast<time_t> (0)),
7752 40c428ea3408 initial implementation of dbup and dbdown John W. Eaton <jwe@octave.org> parents: 7736 diff changeset	78 call_depth (-1)
7736 a059b5679fbb implement dbstack John W. Eaton <jwe@octave.org> parents: 7731 diff changeset	79 {
a059b5679fbb implement dbstack John W. Eaton <jwe@octave.org> parents: 7731 diff changeset	80 if (cmd_list)
a059b5679fbb implement dbstack John W. Eaton <jwe@octave.org> parents: 7731 diff changeset	81 cmd_list->mark_as_script_body ();
a059b5679fbb implement dbstack John W. Eaton <jwe@octave.org> parents: 7731 diff changeset	82 }
7731 2d2a969c731c fix max_recursion_limit exceeded at startup with Intel C++ Jaroslav Hajek <highegg@gmail.com> parents: 7719 diff changeset	83
2d2a969c731c fix max_recursion_limit exceeded at startup with Intel C++ Jaroslav Hajek <highegg@gmail.com> parents: 7719 diff changeset	84 octave_user_script::octave_user_script (const std::string& fnm,
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	85 const std::string& nm,
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	86 const std::string& ds)
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11558 diff changeset	87 : octave_user_code (nm, ds), cmd_list (0), file_name (fnm),
7731 2d2a969c731c fix max_recursion_limit exceeded at startup with Intel C++ Jaroslav Hajek <highegg@gmail.com> parents: 7719 diff changeset	88 t_parsed (static_cast<time_t> (0)),
2d2a969c731c fix max_recursion_limit exceeded at startup with Intel C++ Jaroslav Hajek <highegg@gmail.com> parents: 7719 diff changeset	89 t_checked (static_cast<time_t> (0)),
7752 40c428ea3408 initial implementation of dbup and dbdown John W. Eaton <jwe@octave.org> parents: 7736 diff changeset	90 call_depth (-1)
7731 2d2a969c731c fix max_recursion_limit exceeded at startup with Intel C++ Jaroslav Hajek <highegg@gmail.com> parents: 7719 diff changeset	91 { }
2d2a969c731c fix max_recursion_limit exceeded at startup with Intel C++ Jaroslav Hajek <highegg@gmail.com> parents: 7719 diff changeset	92
7715 5b4d278ec828 parse scripts completely before executing John W. Eaton <jwe@octave.org> parents: 7589 diff changeset	93 octave_user_script::~octave_user_script (void)
5b4d278ec828 parse scripts completely before executing John W. Eaton <jwe@octave.org> parents: 7589 diff changeset	94 {
5b4d278ec828 parse scripts completely before executing John W. Eaton <jwe@octave.org> parents: 7589 diff changeset	95 delete cmd_list;
5b4d278ec828 parse scripts completely before executing John W. Eaton <jwe@octave.org> parents: 7589 diff changeset	96 }
5b4d278ec828 parse scripts completely before executing John W. Eaton <jwe@octave.org> parents: 7589 diff changeset	97
5b4d278ec828 parse scripts completely before executing John W. Eaton <jwe@octave.org> parents: 7589 diff changeset	98 octave_value_list
5b4d278ec828 parse scripts completely before executing John W. Eaton <jwe@octave.org> parents: 7589 diff changeset	99 octave_user_script::subsref (const std::string&,
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	100 const std::list<octave_value_list>&, int)
7715 5b4d278ec828 parse scripts completely before executing John W. Eaton <jwe@octave.org> parents: 7589 diff changeset	101 {
5b4d278ec828 parse scripts completely before executing John W. Eaton <jwe@octave.org> parents: 7589 diff changeset	102 octave_value_list retval;
5b4d278ec828 parse scripts completely before executing John W. Eaton <jwe@octave.org> parents: 7589 diff changeset	103
10001 6918d86add73 Print script filename in script indexing errors David Grundberg <davidg@cs.umu.se> parents: 9646 diff changeset	104 ::error ("invalid use of script %s in index expression", file_name.c_str ());
7715 5b4d278ec828 parse scripts completely before executing John W. Eaton <jwe@octave.org> parents: 7589 diff changeset	105
5b4d278ec828 parse scripts completely before executing John W. Eaton <jwe@octave.org> parents: 7589 diff changeset	106 return retval;
5b4d278ec828 parse scripts completely before executing John W. Eaton <jwe@octave.org> parents: 7589 diff changeset	107 }
7336 745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe] jwe parents: 7017 diff changeset	108
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe] jwe parents: 7017 diff changeset	109 octave_value_list
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe] jwe parents: 7017 diff changeset	110 octave_user_script::do_multi_index_op (int nargout,
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	111 const octave_value_list& args)
7336 745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe] jwe parents: 7017 diff changeset	112 {
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe] jwe parents: 7017 diff changeset	113 octave_value_list retval;
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe] jwe parents: 7017 diff changeset	114
10066 2cd940306a06 make unwind_protect frames local Jaroslav Hajek <highegg@gmail.com> parents: 10001 diff changeset	115 unwind_protect frame;
8011 3100283874d7 improve backtrace error messages John W. Eaton <jwe@octave.org> parents: 7968 diff changeset	116
7336 745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe] jwe parents: 7017 diff changeset	117 if (! error_state)
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe] jwe parents: 7017 diff changeset	118 {
7715 5b4d278ec828 parse scripts completely before executing John W. Eaton <jwe@octave.org> parents: 7589 diff changeset	119 if (args.length () == 0 && nargout == 0)
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	120 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	121 if (cmd_list)
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	122 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	123 frame.protect_var (call_depth);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	124 call_depth++;
7715 5b4d278ec828 parse scripts completely before executing John W. Eaton <jwe@octave.org> parents: 7589 diff changeset	125
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	126 if (call_depth < Vmax_recursion_depth)
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	127 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	128 octave_call_stack::push (this);
7715 5b4d278ec828 parse scripts completely before executing John W. Eaton <jwe@octave.org> parents: 7589 diff changeset	129
10066 2cd940306a06 make unwind_protect frames local Jaroslav Hajek <highegg@gmail.com> parents: 10001 diff changeset	130 frame.add_fcn (octave_call_stack::pop);
7715 5b4d278ec828 parse scripts completely before executing John W. Eaton <jwe@octave.org> parents: 7589 diff changeset	131
11304 c9fefa096ce2 echo commands in scripts John W. Eaton <jwe@octave.org> parents: 10848 diff changeset	132 frame.protect_var (tree_evaluator::statement_context);
c9fefa096ce2 echo commands in scripts John W. Eaton <jwe@octave.org> parents: 10848 diff changeset	133 tree_evaluator::statement_context = tree_evaluator::script;
8669 33783e94fb16 line number fixes and other evaluator tweaks John W. Eaton <jwe@octave.org> parents: 8658 diff changeset	134
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	135 cmd_list->accept (*current_evaluator);
7336 745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe] jwe parents: 7017 diff changeset	136
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	137 if (tree_return_command::returning)
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	138 tree_return_command::returning = 0;
7715 5b4d278ec828 parse scripts completely before executing John W. Eaton <jwe@octave.org> parents: 7589 diff changeset	139
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	140 if (tree_break_command::breaking)
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	141 tree_break_command::breaking--;
8013 b3e667f1ab4c call backtrace_error_message in eval functions, not when popping stack John W. Eaton <jwe@octave.org> parents: 8011 diff changeset	142
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	143 if (error_state)
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	144 octave_call_stack::backtrace_error_message ();
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	145 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	146 else
10578 cb0883127251 limit on recursion via calls to source function John W. Eaton <jwe@octave.org> parents: 10315 diff changeset	147 ::error ("max_recursion_depth exceeded");
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	148 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	149 }
7336 745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe] jwe parents: 7017 diff changeset	150 else
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	151 error ("invalid call to script %s", file_name.c_str ());
7336 745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe] jwe parents: 7017 diff changeset	152 }
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe] jwe parents: 7017 diff changeset	153
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe] jwe parents: 7017 diff changeset	154 return retval;
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe] jwe parents: 7017 diff changeset	155 }
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe] jwe parents: 7017 diff changeset	156
7715 5b4d278ec828 parse scripts completely before executing John W. Eaton <jwe@octave.org> parents: 7589 diff changeset	157 void
5b4d278ec828 parse scripts completely before executing John W. Eaton <jwe@octave.org> parents: 7589 diff changeset	158 octave_user_script::accept (tree_walker& tw)
5b4d278ec828 parse scripts completely before executing John W. Eaton <jwe@octave.org> parents: 7589 diff changeset	159 {
5b4d278ec828 parse scripts completely before executing John W. Eaton <jwe@octave.org> parents: 7589 diff changeset	160 tw.visit_octave_user_script (*this);
5b4d278ec828 parse scripts completely before executing John W. Eaton <jwe@octave.org> parents: 7589 diff changeset	161 }
5b4d278ec828 parse scripts completely before executing John W. Eaton <jwe@octave.org> parents: 7589 diff changeset	162
2974 ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	163 // User defined functions.
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	164
3219 30770ba4457a [project @ 1998-11-13 03:44:31 by jwe] jwe parents: 3178 diff changeset	165 DEFINE_OCTAVE_ALLOCATOR (octave_user_function);
2974 ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	166
3219 30770ba4457a [project @ 1998-11-13 03:44:31 by jwe] jwe parents: 3178 diff changeset	167 DEFINE_OV_TYPEID_FUNCTIONS_AND_DATA (octave_user_function,
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	168 "user-defined function",
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	169 "user-defined function");
2974 ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	170
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	171 // Ugh. This really needs to be simplified (code/data?
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	172 // extrinsic/intrinsic state?).
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	173
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	174 octave_user_function::octave_user_function
7336 745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe] jwe parents: 7017 diff changeset	175 (symbol_table::scope_id sid, tree_parameter_list *pl,
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe] jwe parents: 7017 diff changeset	176 tree_parameter_list rl, tree_statement_list cl)
7719 87eda1f8faaa octave_user_code: new base class for octave_user_script and octave_user_function John W. Eaton <jwe@octave.org> parents: 7715 diff changeset	177 : octave_user_code (std::string (), std::string ()),
2974 ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	178 param_list (pl), ret_list (rl), cmd_list (cl),
7336 745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe] jwe parents: 7017 diff changeset	179 lead_comm (), trail_comm (), file_name (),
6323 ea65de49e18e [project @ 2007-02-17 02:51:02 by jwe] jwe parents: 6149 diff changeset	180 parent_name (), t_parsed (static_cast<time_t> (0)),
3255 4d33b1e56bff [project @ 1999-07-15 20:54:14 by jwe] jwe parents: 3239 diff changeset	181 t_checked (static_cast<time_t> (0)),
7752 40c428ea3408 initial implementation of dbup and dbdown John W. Eaton <jwe@octave.org> parents: 7736 diff changeset	182 system_fcn_file (false), call_depth (-1),
7589 90fb25a5a3fa minor cleanup in octave_user_function constructor John W. Eaton <jwe@octave.org> parents: 7552 diff changeset	183 num_named_args (param_list ? param_list->length () : 0),
11461 2b8531a6a3c9 Change mentions of "nested function" to the less misleading "subfunction" David Grundberg <individ@acc.umu.se> parents: 11431 diff changeset	184 subfunction (false), inline_function (false),
9522 e79470be3ecb implement subsasgn this-arg optimization Jaroslav Hajek <highegg@gmail.com> parents: 9396 diff changeset	185 class_constructor (false), class_method (false),
10637 9cd5aa83fa62 implement 'local' parameter to pseudo-variables Jaroslav Hajek <highegg@gmail.com> parents: 10578 diff changeset	186 parent_scope (-1), local_scope (sid),
9cd5aa83fa62 implement 'local' parameter to pseudo-variables Jaroslav Hajek <highegg@gmail.com> parents: 10578 diff changeset	187 curr_unwind_protect_frame (0)
7736 a059b5679fbb implement dbstack John W. Eaton <jwe@octave.org> parents: 7731 diff changeset	188 {
a059b5679fbb implement dbstack John W. Eaton <jwe@octave.org> parents: 7731 diff changeset	189 if (cmd_list)
a059b5679fbb implement dbstack John W. Eaton <jwe@octave.org> parents: 7731 diff changeset	190 cmd_list->mark_as_function_body ();
9639 8d79f36ebdde store scope->function pointer Jaroslav Hajek <highegg@gmail.com> parents: 9529 diff changeset	191
8d79f36ebdde store scope->function pointer Jaroslav Hajek <highegg@gmail.com> parents: 9529 diff changeset	192 if (local_scope >= 0)
8d79f36ebdde store scope->function pointer Jaroslav Hajek <highegg@gmail.com> parents: 9529 diff changeset	193 symbol_table::set_curr_fcn (this, local_scope);
7736 a059b5679fbb implement dbstack John W. Eaton <jwe@octave.org> parents: 7731 diff changeset	194 }
2974 ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	195
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	196 octave_user_function::~octave_user_function (void)
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	197 {
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	198 delete param_list;
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	199 delete ret_list;
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	200 delete cmd_list;
3665 0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe] jwe parents: 3565 diff changeset	201 delete lead_comm;
0689afb1d001 [project @ 2000-05-11 19:07:56 by jwe] jwe parents: 3565 diff changeset	202 delete trail_comm;
7336 745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe] jwe parents: 7017 diff changeset	203
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe] jwe parents: 7017 diff changeset	204 symbol_table::erase_scope (local_scope);
2974 ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	205 }
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	206
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	207 octave_user_function *
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	208 octave_user_function::define_ret_list (tree_parameter_list *t)
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	209 {
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	210 ret_list = t;
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	211
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	212 return this;
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	213 }
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	214
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	215 void
4343 db5e0814277a [project @ 2003-02-20 16:44:16 by jwe] jwe parents: 4280 diff changeset	216 octave_user_function::stash_fcn_file_name (const std::string& nm)
2974 ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	217 {
4343 db5e0814277a [project @ 2003-02-20 16:44:16 by jwe] jwe parents: 4280 diff changeset	218 file_name = nm;
2974 ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	219 }
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	220
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	221 void
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	222 octave_user_function::mark_as_system_fcn_file (void)
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	223 {
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	224 if (! file_name.empty ())
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	225 {
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	226 // We really should stash the whole path to the file we found,
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	227 // when we looked it up, to avoid possible race conditions...
5775 ace8d8d26933 [project @ 2006-04-24 19:13:06 by jwe] jwe parents: 5744 diff changeset	228 // FIXME
2974 ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	229 //
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	230 // We probably also don't need to get the library directory
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	231 // every time, but since this function is only called when the
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	232 // function file is parsed, it probably doesn't matter that
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	233 // much.
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	234
3523 b80bbb43a1a9 [project @ 2000-02-02 10:25:52 by jwe] jwe parents: 3489 diff changeset	235 std::string ff_name = fcn_file_in_path (file_name);
2974 ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	236
3565 4290f11c8d3b [project @ 2000-02-03 08:32:41 by jwe] jwe parents: 3544 diff changeset	237 if (Vfcn_file_dir == ff_name.substr (0, Vfcn_file_dir.length ()))
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	238 system_fcn_file = 1;
2974 ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	239 }
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	240 else
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	241 system_fcn_file = 0;
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	242 }
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	243
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	244 bool
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	245 octave_user_function::takes_varargs (void) const
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	246 {
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	247 return (param_list && param_list->takes_varargs ());
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	248 }
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	249
5848 415ae81d331b [project @ 2006-06-08 20:37:29 by jwe] jwe parents: 5823 diff changeset	250 bool
415ae81d331b [project @ 2006-06-08 20:37:29 by jwe] jwe parents: 5823 diff changeset	251 octave_user_function::takes_var_return (void) const
2974 ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	252 {
5848 415ae81d331b [project @ 2006-06-08 20:37:29 by jwe] jwe parents: 5823 diff changeset	253 return (ret_list && ret_list->takes_varargs ());
2974 ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	254 }
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	255
7761 5adeea5de26c symbol table reporting functions John W. Eaton <jwe@octave.org> parents: 7752 diff changeset	256 void
5adeea5de26c symbol table reporting functions John W. Eaton <jwe@octave.org> parents: 7752 diff changeset	257 octave_user_function::lock_subfunctions (void)
5adeea5de26c symbol table reporting functions John W. Eaton <jwe@octave.org> parents: 7752 diff changeset	258 {
5adeea5de26c symbol table reporting functions John W. Eaton <jwe@octave.org> parents: 7752 diff changeset	259 symbol_table::lock_subfunctions (local_scope);
5adeea5de26c symbol table reporting functions John W. Eaton <jwe@octave.org> parents: 7752 diff changeset	260 }
5adeea5de26c symbol table reporting functions John W. Eaton <jwe@octave.org> parents: 7752 diff changeset	261
5adeea5de26c symbol table reporting functions John W. Eaton <jwe@octave.org> parents: 7752 diff changeset	262 void
5adeea5de26c symbol table reporting functions John W. Eaton <jwe@octave.org> parents: 7752 diff changeset	263 octave_user_function::unlock_subfunctions (void)
5adeea5de26c symbol table reporting functions John W. Eaton <jwe@octave.org> parents: 7752 diff changeset	264 {
5adeea5de26c symbol table reporting functions John W. Eaton <jwe@octave.org> parents: 7752 diff changeset	265 symbol_table::unlock_subfunctions (local_scope);
5adeea5de26c symbol table reporting functions John W. Eaton <jwe@octave.org> parents: 7752 diff changeset	266 }
5adeea5de26c symbol table reporting functions John W. Eaton <jwe@octave.org> parents: 7752 diff changeset	267
2974 ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	268 octave_value_list
9522 e79470be3ecb implement subsasgn this-arg optimization Jaroslav Hajek <highegg@gmail.com> parents: 9396 diff changeset	269 octave_user_function::all_va_args (const octave_value_list& args)
2974 ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	270 {
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	271 octave_value_list retval;
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	272
9522 e79470be3ecb implement subsasgn this-arg optimization Jaroslav Hajek <highegg@gmail.com> parents: 9396 diff changeset	273 octave_idx_type n = args.length () - num_named_args;
2974 ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	274
3178 09a3064a3a17 [project @ 1998-06-23 03:46:42 by jwe] jwe parents: 3165 diff changeset	275 if (n > 0)
9522 e79470be3ecb implement subsasgn this-arg optimization Jaroslav Hajek <highegg@gmail.com> parents: 9396 diff changeset	276 retval = args.slice (num_named_args, n);
2974 ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	277
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	278 return retval;
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	279 }
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	280
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	281 octave_value_list
4247 fc9a075d10fb [project @ 2002-12-30 23:05:27 by jwe] jwe parents: 4245 diff changeset	282 octave_user_function::subsref (const std::string& type,
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	283 const std::list<octave_value_list>& idx,
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	284 int nargout)
3933 f9ea3dcf58ee [project @ 2002-05-15 03:21:00 by jwe] jwe parents: 3876 diff changeset	285 {
10832 1b2fcd122c6a allow user detect ignored outputs in m-functions Jaroslav Hajek <highegg@gmail.com> parents: 10637 diff changeset	286 return octave_user_function::subsref (type, idx, nargout, 0);
1b2fcd122c6a allow user detect ignored outputs in m-functions Jaroslav Hajek <highegg@gmail.com> parents: 10637 diff changeset	287 }
1b2fcd122c6a allow user detect ignored outputs in m-functions Jaroslav Hajek <highegg@gmail.com> parents: 10637 diff changeset	288
1b2fcd122c6a allow user detect ignored outputs in m-functions Jaroslav Hajek <highegg@gmail.com> parents: 10637 diff changeset	289 octave_value_list
1b2fcd122c6a allow user detect ignored outputs in m-functions Jaroslav Hajek <highegg@gmail.com> parents: 10637 diff changeset	290 octave_user_function::subsref (const std::string& type,
1b2fcd122c6a allow user detect ignored outputs in m-functions Jaroslav Hajek <highegg@gmail.com> parents: 10637 diff changeset	291 const std::list<octave_value_list>& idx,
1b2fcd122c6a allow user detect ignored outputs in m-functions Jaroslav Hajek <highegg@gmail.com> parents: 10637 diff changeset	292 int nargout, const std::list<octave_lvalue>* lvalue_list)
1b2fcd122c6a allow user detect ignored outputs in m-functions Jaroslav Hajek <highegg@gmail.com> parents: 10637 diff changeset	293 {
3933 f9ea3dcf58ee [project @ 2002-05-15 03:21:00 by jwe] jwe parents: 3876 diff changeset	294 octave_value_list retval;
f9ea3dcf58ee [project @ 2002-05-15 03:21:00 by jwe] jwe parents: 3876 diff changeset	295
f9ea3dcf58ee [project @ 2002-05-15 03:21:00 by jwe] jwe parents: 3876 diff changeset	296 switch (type[0])
f9ea3dcf58ee [project @ 2002-05-15 03:21:00 by jwe] jwe parents: 3876 diff changeset	297 {
f9ea3dcf58ee [project @ 2002-05-15 03:21:00 by jwe] jwe parents: 3876 diff changeset	298 case '(':
5154 9cb38bfb04ea [project @ 2005-02-21 21:23:28 by jwe] jwe parents: 5105 diff changeset	299 {
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	300 int tmp_nargout = (type.length () > 1 && nargout == 0) ? 1 : nargout;
5154 9cb38bfb04ea [project @ 2005-02-21 21:23:28 by jwe] jwe parents: 5105 diff changeset	301
10832 1b2fcd122c6a allow user detect ignored outputs in m-functions Jaroslav Hajek <highegg@gmail.com> parents: 10637 diff changeset	302 retval = do_multi_index_op (tmp_nargout, idx.front (),
1b2fcd122c6a allow user detect ignored outputs in m-functions Jaroslav Hajek <highegg@gmail.com> parents: 10637 diff changeset	303 idx.size () == 1 ? lvalue_list : 0);
5154 9cb38bfb04ea [project @ 2005-02-21 21:23:28 by jwe] jwe parents: 5105 diff changeset	304 }
3933 f9ea3dcf58ee [project @ 2002-05-15 03:21:00 by jwe] jwe parents: 3876 diff changeset	305 break;
f9ea3dcf58ee [project @ 2002-05-15 03:21:00 by jwe] jwe parents: 3876 diff changeset	306
f9ea3dcf58ee [project @ 2002-05-15 03:21:00 by jwe] jwe parents: 3876 diff changeset	307 case '{':
f9ea3dcf58ee [project @ 2002-05-15 03:21:00 by jwe] jwe parents: 3876 diff changeset	308 case '.':
f9ea3dcf58ee [project @ 2002-05-15 03:21:00 by jwe] jwe parents: 3876 diff changeset	309 {
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	310 std::string nm = type_name ();
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	311 error ("%s cannot be indexed with %c", nm.c_str (), type[0]);
3933 f9ea3dcf58ee [project @ 2002-05-15 03:21:00 by jwe] jwe parents: 3876 diff changeset	312 }
f9ea3dcf58ee [project @ 2002-05-15 03:21:00 by jwe] jwe parents: 3876 diff changeset	313 break;
f9ea3dcf58ee [project @ 2002-05-15 03:21:00 by jwe] jwe parents: 3876 diff changeset	314
f9ea3dcf58ee [project @ 2002-05-15 03:21:00 by jwe] jwe parents: 3876 diff changeset	315 default:
f9ea3dcf58ee [project @ 2002-05-15 03:21:00 by jwe] jwe parents: 3876 diff changeset	316 panic_impossible ();
f9ea3dcf58ee [project @ 2002-05-15 03:21:00 by jwe] jwe parents: 3876 diff changeset	317 }
f9ea3dcf58ee [project @ 2002-05-15 03:21:00 by jwe] jwe parents: 3876 diff changeset	318
5775 ace8d8d26933 [project @ 2006-04-24 19:13:06 by jwe] jwe parents: 5744 diff changeset	319 // FIXME -- perhaps there should be an
4059 db58c1a1e6ce [project @ 2002-09-18 07:21:12 by jwe] jwe parents: 3975 diff changeset	320 // octave_value_list::next_subsref member function? See also
db58c1a1e6ce [project @ 2002-09-18 07:21:12 by jwe] jwe parents: 3975 diff changeset	321 // octave_builtin::subsref.
3933 f9ea3dcf58ee [project @ 2002-05-15 03:21:00 by jwe] jwe parents: 3876 diff changeset	322
4219 23d06c9e1edd [project @ 2002-12-06 21:29:17 by jwe] jwe parents: 4207 diff changeset	323 if (idx.size () > 1)
4994 48d0defe9445 [project @ 2004-09-15 20:31:31 by jwe] jwe parents: 4987 diff changeset	324 retval = retval(0).next_subsref (nargout, type, idx);
4059 db58c1a1e6ce [project @ 2002-09-18 07:21:12 by jwe] jwe parents: 3975 diff changeset	325
db58c1a1e6ce [project @ 2002-09-18 07:21:12 by jwe] jwe parents: 3975 diff changeset	326 return retval;
3933 f9ea3dcf58ee [project @ 2002-05-15 03:21:00 by jwe] jwe parents: 3876 diff changeset	327 }
f9ea3dcf58ee [project @ 2002-05-15 03:21:00 by jwe] jwe parents: 3876 diff changeset	328
f9ea3dcf58ee [project @ 2002-05-15 03:21:00 by jwe] jwe parents: 3876 diff changeset	329 octave_value_list
3544 71bd2d124119 [project @ 2000-02-02 21:02:31 by jwe] jwe parents: 3523 diff changeset	330 octave_user_function::do_multi_index_op (int nargout,
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	331 const octave_value_list& args)
2974 ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	332 {
10832 1b2fcd122c6a allow user detect ignored outputs in m-functions Jaroslav Hajek <highegg@gmail.com> parents: 10637 diff changeset	333 return do_multi_index_op (nargout, args, 0);
1b2fcd122c6a allow user detect ignored outputs in m-functions Jaroslav Hajek <highegg@gmail.com> parents: 10637 diff changeset	334 }
1b2fcd122c6a allow user detect ignored outputs in m-functions Jaroslav Hajek <highegg@gmail.com> parents: 10637 diff changeset	335
1b2fcd122c6a allow user detect ignored outputs in m-functions Jaroslav Hajek <highegg@gmail.com> parents: 10637 diff changeset	336 octave_value_list
1b2fcd122c6a allow user detect ignored outputs in m-functions Jaroslav Hajek <highegg@gmail.com> parents: 10637 diff changeset	337 octave_user_function::do_multi_index_op (int nargout,
1b2fcd122c6a allow user detect ignored outputs in m-functions Jaroslav Hajek <highegg@gmail.com> parents: 10637 diff changeset	338 const octave_value_list& args,
1b2fcd122c6a allow user detect ignored outputs in m-functions Jaroslav Hajek <highegg@gmail.com> parents: 10637 diff changeset	339 const std::list<octave_lvalue>* lvalue_list)
1b2fcd122c6a allow user detect ignored outputs in m-functions Jaroslav Hajek <highegg@gmail.com> parents: 10637 diff changeset	340 {
2974 ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	341 octave_value_list retval;
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	342
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	343 if (error_state)
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	344 return retval;
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	345
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	346 if (! cmd_list)
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	347 return retval;
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	348
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	349 int nargin = args.length ();
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	350
10066 2cd940306a06 make unwind_protect frames local Jaroslav Hajek <highegg@gmail.com> parents: 10001 diff changeset	351 unwind_protect frame;
2974 ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	352
10066 2cd940306a06 make unwind_protect frames local Jaroslav Hajek <highegg@gmail.com> parents: 10001 diff changeset	353 frame.protect_var (call_depth);
2974 ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	354 call_depth++;
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	355
7752 40c428ea3408 initial implementation of dbup and dbdown John W. Eaton <jwe@octave.org> parents: 7736 diff changeset	356 if (call_depth >= Vmax_recursion_depth)
3131 9c5160c83bd2 [project @ 1998-01-29 04:46:33 by jwe] jwe parents: 3014 diff changeset	357 {
10578 cb0883127251 limit on recursion via calls to source function John W. Eaton <jwe@octave.org> parents: 10315 diff changeset	358 ::error ("max_recursion_depth exceeded");
3131 9c5160c83bd2 [project @ 1998-01-29 04:46:33 by jwe] jwe parents: 3014 diff changeset	359 return retval;
9c5160c83bd2 [project @ 1998-01-29 04:46:33 by jwe] jwe parents: 3014 diff changeset	360 }
9c5160c83bd2 [project @ 1998-01-29 04:46:33 by jwe] jwe parents: 3014 diff changeset	361
7336 745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe] jwe parents: 7017 diff changeset	362 // Save old and set current symbol table context, for
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe] jwe parents: 7017 diff changeset	363 // eval_undefined_error().
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe] jwe parents: 7017 diff changeset	364
7901 3e4c9b69069d call stack changes John W. Eaton <jwe@octave.org> parents: 7761 diff changeset	365 octave_call_stack::push (this, local_scope, call_depth);
10066 2cd940306a06 make unwind_protect frames local Jaroslav Hajek <highegg@gmail.com> parents: 10001 diff changeset	366 frame.add_fcn (octave_call_stack::pop);
7901 3e4c9b69069d call stack changes John W. Eaton <jwe@octave.org> parents: 7761 diff changeset	367
7752 40c428ea3408 initial implementation of dbup and dbdown John W. Eaton <jwe@octave.org> parents: 7736 diff changeset	368 if (call_depth > 0)
2974 ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	369 {
7336 745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe] jwe parents: 7017 diff changeset	370 symbol_table::push_context ();
2974 ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	371
10066 2cd940306a06 make unwind_protect frames local Jaroslav Hajek <highegg@gmail.com> parents: 10001 diff changeset	372 frame.add_fcn (symbol_table::pop_context);
7336 745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe] jwe parents: 7017 diff changeset	373 }
2974 ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	374
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	375 string_vector arg_names = args.name_tags ();
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	376
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	377 if (param_list && ! param_list->varargs_only ())
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	378 {
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	379 param_list->define_from_arg_vector (args);
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	380 if (error_state)
10066 2cd940306a06 make unwind_protect frames local Jaroslav Hajek <highegg@gmail.com> parents: 10001 diff changeset	381 return retval;
2974 ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	382 }
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	383
3239 d54ef0aa6e82 [project @ 1999-03-27 17:40:45 by jwe] jwe parents: 3219 diff changeset	384 // Force parameter list to be undefined when this function exits.
d54ef0aa6e82 [project @ 1999-03-27 17:40:45 by jwe] jwe parents: 3219 diff changeset	385 // Doing so decrements the reference counts on the values of local
d54ef0aa6e82 [project @ 1999-03-27 17:40:45 by jwe] jwe parents: 3219 diff changeset	386 // variables that are also named function parameters.
d54ef0aa6e82 [project @ 1999-03-27 17:40:45 by jwe] jwe parents: 3219 diff changeset	387
9396 17af7cce7d1b yet more unwind_protect improvements Jaroslav Hajek <highegg@gmail.com> parents: 9377 diff changeset	388 if (param_list)
10066 2cd940306a06 make unwind_protect frames local Jaroslav Hajek <highegg@gmail.com> parents: 10001 diff changeset	389 frame.add_method (param_list, &tree_parameter_list::undefine);
3239 d54ef0aa6e82 [project @ 1999-03-27 17:40:45 by jwe] jwe parents: 3219 diff changeset	390
d54ef0aa6e82 [project @ 1999-03-27 17:40:45 by jwe] jwe parents: 3219 diff changeset	391 // Force return list to be undefined when this function exits.
d54ef0aa6e82 [project @ 1999-03-27 17:40:45 by jwe] jwe parents: 3219 diff changeset	392 // Doing so decrements the reference counts on the values of local
d54ef0aa6e82 [project @ 1999-03-27 17:40:45 by jwe] jwe parents: 3219 diff changeset	393 // variables that are also named values returned by this function.
d54ef0aa6e82 [project @ 1999-03-27 17:40:45 by jwe] jwe parents: 3219 diff changeset	394
9396 17af7cce7d1b yet more unwind_protect improvements Jaroslav Hajek <highegg@gmail.com> parents: 9377 diff changeset	395 if (ret_list)
10066 2cd940306a06 make unwind_protect frames local Jaroslav Hajek <highegg@gmail.com> parents: 10001 diff changeset	396 frame.add_method (ret_list, &tree_parameter_list::undefine);
3239 d54ef0aa6e82 [project @ 1999-03-27 17:40:45 by jwe] jwe parents: 3219 diff changeset	397
8142 54b41376e381 ov-usr-fcn.cc (octave_user_function::do_multi_index_op): add symbol_table::clear_variables cleanup function to the unwind_protect stack after the parameter list cleanup functions John W. Eaton <jwe@octave.org> parents: 8013 diff changeset	398 if (call_depth == 0)
54b41376e381 ov-usr-fcn.cc (octave_user_function::do_multi_index_op): add symbol_table::clear_variables cleanup function to the unwind_protect stack after the parameter list cleanup functions John W. Eaton <jwe@octave.org> parents: 8013 diff changeset	399 {
54b41376e381 ov-usr-fcn.cc (octave_user_function::do_multi_index_op): add symbol_table::clear_variables cleanup function to the unwind_protect stack after the parameter list cleanup functions John W. Eaton <jwe@octave.org> parents: 8013 diff changeset	400 // Force symbols to be undefined again when this function
54b41376e381 ov-usr-fcn.cc (octave_user_function::do_multi_index_op): add symbol_table::clear_variables cleanup function to the unwind_protect stack after the parameter list cleanup functions John W. Eaton <jwe@octave.org> parents: 8013 diff changeset	401 // exits.
54b41376e381 ov-usr-fcn.cc (octave_user_function::do_multi_index_op): add symbol_table::clear_variables cleanup function to the unwind_protect stack after the parameter list cleanup functions John W. Eaton <jwe@octave.org> parents: 8013 diff changeset	402 //
54b41376e381 ov-usr-fcn.cc (octave_user_function::do_multi_index_op): add symbol_table::clear_variables cleanup function to the unwind_protect stack after the parameter list cleanup functions John W. Eaton <jwe@octave.org> parents: 8013 diff changeset	403 // This cleanup function is added to the unwind_protect stack
54b41376e381 ov-usr-fcn.cc (octave_user_function::do_multi_index_op): add symbol_table::clear_variables cleanup function to the unwind_protect stack after the parameter list cleanup functions John W. Eaton <jwe@octave.org> parents: 8013 diff changeset	404 // after the calls to clear the parameter lists so that local
54b41376e381 ov-usr-fcn.cc (octave_user_function::do_multi_index_op): add symbol_table::clear_variables cleanup function to the unwind_protect stack after the parameter list cleanup functions John W. Eaton <jwe@octave.org> parents: 8013 diff changeset	405 // variables will be cleared before the parameter lists are
54b41376e381 ov-usr-fcn.cc (octave_user_function::do_multi_index_op): add symbol_table::clear_variables cleanup function to the unwind_protect stack after the parameter list cleanup functions John W. Eaton <jwe@octave.org> parents: 8013 diff changeset	406 // cleared. That way, any function parameters that have been
54b41376e381 ov-usr-fcn.cc (octave_user_function::do_multi_index_op): add symbol_table::clear_variables cleanup function to the unwind_protect stack after the parameter list cleanup functions John W. Eaton <jwe@octave.org> parents: 8013 diff changeset	407 // declared global will be unmarked as global before they are
54b41376e381 ov-usr-fcn.cc (octave_user_function::do_multi_index_op): add symbol_table::clear_variables cleanup function to the unwind_protect stack after the parameter list cleanup functions John W. Eaton <jwe@octave.org> parents: 8013 diff changeset	408 // undefined by the clear_param_list cleanup function.
54b41376e381 ov-usr-fcn.cc (octave_user_function::do_multi_index_op): add symbol_table::clear_variables cleanup function to the unwind_protect stack after the parameter list cleanup functions John W. Eaton <jwe@octave.org> parents: 8013 diff changeset	409
10066 2cd940306a06 make unwind_protect frames local Jaroslav Hajek <highegg@gmail.com> parents: 10001 diff changeset	410 frame.add_fcn (symbol_table::clear_variables);
8142 54b41376e381 ov-usr-fcn.cc (octave_user_function::do_multi_index_op): add symbol_table::clear_variables cleanup function to the unwind_protect stack after the parameter list cleanup functions John W. Eaton <jwe@octave.org> parents: 8013 diff changeset	411 }
54b41376e381 ov-usr-fcn.cc (octave_user_function::do_multi_index_op): add symbol_table::clear_variables cleanup function to the unwind_protect stack after the parameter list cleanup functions John W. Eaton <jwe@octave.org> parents: 8013 diff changeset	412
10832 1b2fcd122c6a allow user detect ignored outputs in m-functions Jaroslav Hajek <highegg@gmail.com> parents: 10637 diff changeset	413 bind_automatic_vars (arg_names, nargin, nargout, all_va_args (args),
1b2fcd122c6a allow user detect ignored outputs in m-functions Jaroslav Hajek <highegg@gmail.com> parents: 10637 diff changeset	414 lvalue_list);
2974 ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	415
10066 2cd940306a06 make unwind_protect frames local Jaroslav Hajek <highegg@gmail.com> parents: 10001 diff changeset	416 bool echo_commands = (Vecho_executing_commands & ECHO_FUNCTIONS);
2974 ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	417
10066 2cd940306a06 make unwind_protect frames local Jaroslav Hajek <highegg@gmail.com> parents: 10001 diff changeset	418 if (echo_commands)
2cd940306a06 make unwind_protect frames local Jaroslav Hajek <highegg@gmail.com> parents: 10001 diff changeset	419 print_code_function_header ();
2974 ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	420
10637 9cd5aa83fa62 implement 'local' parameter to pseudo-variables Jaroslav Hajek <highegg@gmail.com> parents: 10578 diff changeset	421 // Set pointer to the current unwind_protect frame to allow
9cd5aa83fa62 implement 'local' parameter to pseudo-variables Jaroslav Hajek <highegg@gmail.com> parents: 10578 diff changeset	422 // certain builtins register simple cleanup in a very optimized manner.
9cd5aa83fa62 implement 'local' parameter to pseudo-variables Jaroslav Hajek <highegg@gmail.com> parents: 10578 diff changeset	423 // This is not intended as a general-purpose on-cleanup mechanism,
9cd5aa83fa62 implement 'local' parameter to pseudo-variables Jaroslav Hajek <highegg@gmail.com> parents: 10578 diff changeset	424 frame.protect_var (curr_unwind_protect_frame);
9cd5aa83fa62 implement 'local' parameter to pseudo-variables Jaroslav Hajek <highegg@gmail.com> parents: 10578 diff changeset	425 curr_unwind_protect_frame = &frame;
9cd5aa83fa62 implement 'local' parameter to pseudo-variables Jaroslav Hajek <highegg@gmail.com> parents: 10578 diff changeset	426
10066 2cd940306a06 make unwind_protect frames local Jaroslav Hajek <highegg@gmail.com> parents: 10001 diff changeset	427 // Evaluate the commands that make up the function.
2974 ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	428
11304 c9fefa096ce2 echo commands in scripts John W. Eaton <jwe@octave.org> parents: 10848 diff changeset	429 frame.protect_var (tree_evaluator::statement_context);
c9fefa096ce2 echo commands in scripts John W. Eaton <jwe@octave.org> parents: 10848 diff changeset	430 tree_evaluator::statement_context = tree_evaluator::function;
3489 cbee5fbb696d [project @ 2000-01-28 09:14:32 by jwe] jwe parents: 3445 diff changeset	431
10066 2cd940306a06 make unwind_protect frames local Jaroslav Hajek <highegg@gmail.com> parents: 10001 diff changeset	432 bool special_expr = (is_inline_function ()
2cd940306a06 make unwind_protect frames local Jaroslav Hajek <highegg@gmail.com> parents: 10001 diff changeset	433 \|\| cmd_list->is_anon_function_body ());
8658 73c4516fae10 New evaluator and debugger derived from tree-walker class John W. Eaton <jwe@octave.org> parents: 8580 diff changeset	434
10066 2cd940306a06 make unwind_protect frames local Jaroslav Hajek <highegg@gmail.com> parents: 10001 diff changeset	435 if (special_expr)
2cd940306a06 make unwind_protect frames local Jaroslav Hajek <highegg@gmail.com> parents: 10001 diff changeset	436 {
2cd940306a06 make unwind_protect frames local Jaroslav Hajek <highegg@gmail.com> parents: 10001 diff changeset	437 assert (cmd_list->length () == 1);
6657 86354a8cd6a7 [project @ 2007-05-23 04:35:04 by jwe] jwe parents: 6591 diff changeset	438
10066 2cd940306a06 make unwind_protect frames local Jaroslav Hajek <highegg@gmail.com> parents: 10001 diff changeset	439 tree_statement *stmt = 0;
8658 73c4516fae10 New evaluator and debugger derived from tree-walker class John W. Eaton <jwe@octave.org> parents: 8580 diff changeset	440
10066 2cd940306a06 make unwind_protect frames local Jaroslav Hajek <highegg@gmail.com> parents: 10001 diff changeset	441 if ((stmt = cmd_list->front ())
2cd940306a06 make unwind_protect frames local Jaroslav Hajek <highegg@gmail.com> parents: 10001 diff changeset	442 && stmt->is_expression ())
2cd940306a06 make unwind_protect frames local Jaroslav Hajek <highegg@gmail.com> parents: 10001 diff changeset	443 {
2cd940306a06 make unwind_protect frames local Jaroslav Hajek <highegg@gmail.com> parents: 10001 diff changeset	444 tree_expression *expr = stmt->expression ();
8658 73c4516fae10 New evaluator and debugger derived from tree-walker class John W. Eaton <jwe@octave.org> parents: 8580 diff changeset	445
10066 2cd940306a06 make unwind_protect frames local Jaroslav Hajek <highegg@gmail.com> parents: 10001 diff changeset	446 retval = expr->rvalue (nargout);
2cd940306a06 make unwind_protect frames local Jaroslav Hajek <highegg@gmail.com> parents: 10001 diff changeset	447 }
2cd940306a06 make unwind_protect frames local Jaroslav Hajek <highegg@gmail.com> parents: 10001 diff changeset	448 }
2cd940306a06 make unwind_protect frames local Jaroslav Hajek <highegg@gmail.com> parents: 10001 diff changeset	449 else
2cd940306a06 make unwind_protect frames local Jaroslav Hajek <highegg@gmail.com> parents: 10001 diff changeset	450 cmd_list->accept (*current_evaluator);
2974 ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	451
10066 2cd940306a06 make unwind_protect frames local Jaroslav Hajek <highegg@gmail.com> parents: 10001 diff changeset	452 if (echo_commands)
2cd940306a06 make unwind_protect frames local Jaroslav Hajek <highegg@gmail.com> parents: 10001 diff changeset	453 print_code_function_trailer ();
2974 ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	454
10066 2cd940306a06 make unwind_protect frames local Jaroslav Hajek <highegg@gmail.com> parents: 10001 diff changeset	455 if (tree_return_command::returning)
2cd940306a06 make unwind_protect frames local Jaroslav Hajek <highegg@gmail.com> parents: 10001 diff changeset	456 tree_return_command::returning = 0;
2974 ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	457
10066 2cd940306a06 make unwind_protect frames local Jaroslav Hajek <highegg@gmail.com> parents: 10001 diff changeset	458 if (tree_break_command::breaking)
2cd940306a06 make unwind_protect frames local Jaroslav Hajek <highegg@gmail.com> parents: 10001 diff changeset	459 tree_break_command::breaking--;
2974 ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	460
10066 2cd940306a06 make unwind_protect frames local Jaroslav Hajek <highegg@gmail.com> parents: 10001 diff changeset	461 if (error_state)
2cd940306a06 make unwind_protect frames local Jaroslav Hajek <highegg@gmail.com> parents: 10001 diff changeset	462 {
2cd940306a06 make unwind_protect frames local Jaroslav Hajek <highegg@gmail.com> parents: 10001 diff changeset	463 octave_call_stack::backtrace_error_message ();
2cd940306a06 make unwind_protect frames local Jaroslav Hajek <highegg@gmail.com> parents: 10001 diff changeset	464 return retval;
2cd940306a06 make unwind_protect frames local Jaroslav Hajek <highegg@gmail.com> parents: 10001 diff changeset	465 }
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11558 diff changeset	466
10066 2cd940306a06 make unwind_protect frames local Jaroslav Hajek <highegg@gmail.com> parents: 10001 diff changeset	467 // Copy return values out.
2974 ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	468
10066 2cd940306a06 make unwind_protect frames local Jaroslav Hajek <highegg@gmail.com> parents: 10001 diff changeset	469 if (ret_list && ! special_expr)
2cd940306a06 make unwind_protect frames local Jaroslav Hajek <highegg@gmail.com> parents: 10001 diff changeset	470 {
2cd940306a06 make unwind_protect frames local Jaroslav Hajek <highegg@gmail.com> parents: 10001 diff changeset	471 ret_list->initialize_undefined_elements (my_name, nargout, Matrix ());
5848 415ae81d331b [project @ 2006-06-08 20:37:29 by jwe] jwe parents: 5823 diff changeset	472
10066 2cd940306a06 make unwind_protect frames local Jaroslav Hajek <highegg@gmail.com> parents: 10001 diff changeset	473 Cell varargout;
6591 fc0218995ee7 [project @ 2007-04-27 02:17:34 by jwe] jwe parents: 6505 diff changeset	474
10066 2cd940306a06 make unwind_protect frames local Jaroslav Hajek <highegg@gmail.com> parents: 10001 diff changeset	475 if (ret_list->takes_varargs ())
2cd940306a06 make unwind_protect frames local Jaroslav Hajek <highegg@gmail.com> parents: 10001 diff changeset	476 {
2cd940306a06 make unwind_protect frames local Jaroslav Hajek <highegg@gmail.com> parents: 10001 diff changeset	477 octave_value varargout_varval = symbol_table::varval ("varargout");
5848 415ae81d331b [project @ 2006-06-08 20:37:29 by jwe] jwe parents: 5823 diff changeset	478
10066 2cd940306a06 make unwind_protect frames local Jaroslav Hajek <highegg@gmail.com> parents: 10001 diff changeset	479 if (varargout_varval.is_defined ())
2cd940306a06 make unwind_protect frames local Jaroslav Hajek <highegg@gmail.com> parents: 10001 diff changeset	480 {
2cd940306a06 make unwind_protect frames local Jaroslav Hajek <highegg@gmail.com> parents: 10001 diff changeset	481 varargout = varargout_varval.cell_value ();
5848 415ae81d331b [project @ 2006-06-08 20:37:29 by jwe] jwe parents: 5823 diff changeset	482
10066 2cd940306a06 make unwind_protect frames local Jaroslav Hajek <highegg@gmail.com> parents: 10001 diff changeset	483 if (error_state)
2cd940306a06 make unwind_protect frames local Jaroslav Hajek <highegg@gmail.com> parents: 10001 diff changeset	484 error ("expecting varargout to be a cell array object");
2cd940306a06 make unwind_protect frames local Jaroslav Hajek <highegg@gmail.com> parents: 10001 diff changeset	485 }
2cd940306a06 make unwind_protect frames local Jaroslav Hajek <highegg@gmail.com> parents: 10001 diff changeset	486 }
2974 ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	487
10066 2cd940306a06 make unwind_protect frames local Jaroslav Hajek <highegg@gmail.com> parents: 10001 diff changeset	488 if (! error_state)
2cd940306a06 make unwind_protect frames local Jaroslav Hajek <highegg@gmail.com> parents: 10001 diff changeset	489 retval = ret_list->convert_to_const_vector (nargout, varargout);
2cd940306a06 make unwind_protect frames local Jaroslav Hajek <highegg@gmail.com> parents: 10001 diff changeset	490 }
2974 ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	491
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	492 return retval;
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	493 }
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	494
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	495 void
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	496 octave_user_function::accept (tree_walker& tw)
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	497 {
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	498 tw.visit_octave_user_function (*this);
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	499 }
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	500
9522 e79470be3ecb implement subsasgn this-arg optimization Jaroslav Hajek <highegg@gmail.com> parents: 9396 diff changeset	501 bool
e79470be3ecb implement subsasgn this-arg optimization Jaroslav Hajek <highegg@gmail.com> parents: 9396 diff changeset	502 octave_user_function::subsasgn_optimization_ok (void)
e79470be3ecb implement subsasgn this-arg optimization Jaroslav Hajek <highegg@gmail.com> parents: 9396 diff changeset	503 {
e79470be3ecb implement subsasgn this-arg optimization Jaroslav Hajek <highegg@gmail.com> parents: 9396 diff changeset	504 bool retval = false;
e79470be3ecb implement subsasgn this-arg optimization Jaroslav Hajek <highegg@gmail.com> parents: 9396 diff changeset	505 if (Voptimize_subsasgn_calls
e79470be3ecb implement subsasgn this-arg optimization Jaroslav Hajek <highegg@gmail.com> parents: 9396 diff changeset	506 && param_list->length () > 0 && ! param_list->varargs_only ()
e79470be3ecb implement subsasgn this-arg optimization Jaroslav Hajek <highegg@gmail.com> parents: 9396 diff changeset	507 && ret_list->length () == 1 && ! ret_list->takes_varargs ())
e79470be3ecb implement subsasgn this-arg optimization Jaroslav Hajek <highegg@gmail.com> parents: 9396 diff changeset	508 {
e79470be3ecb implement subsasgn this-arg optimization Jaroslav Hajek <highegg@gmail.com> parents: 9396 diff changeset	509 tree_identifier *par1 = param_list->front ()->ident ();
e79470be3ecb implement subsasgn this-arg optimization Jaroslav Hajek <highegg@gmail.com> parents: 9396 diff changeset	510 tree_identifier *ret1 = ret_list->front ()->ident ();
e79470be3ecb implement subsasgn this-arg optimization Jaroslav Hajek <highegg@gmail.com> parents: 9396 diff changeset	511 retval = par1->name () == ret1->name ();
e79470be3ecb implement subsasgn this-arg optimization Jaroslav Hajek <highegg@gmail.com> parents: 9396 diff changeset	512 }
e79470be3ecb implement subsasgn this-arg optimization Jaroslav Hajek <highegg@gmail.com> parents: 9396 diff changeset	513
e79470be3ecb implement subsasgn this-arg optimization Jaroslav Hajek <highegg@gmail.com> parents: 9396 diff changeset	514 return retval;
e79470be3ecb implement subsasgn this-arg optimization Jaroslav Hajek <highegg@gmail.com> parents: 9396 diff changeset	515 }
e79470be3ecb implement subsasgn this-arg optimization Jaroslav Hajek <highegg@gmail.com> parents: 9396 diff changeset	516
7336 745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe] jwe parents: 7017 diff changeset	517 #if 0
2974 ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	518 void
3933 f9ea3dcf58ee [project @ 2002-05-15 03:21:00 by jwe] jwe parents: 3876 diff changeset	519 octave_user_function::print_symtab_info (std::ostream& os) const
f9ea3dcf58ee [project @ 2002-05-15 03:21:00 by jwe] jwe parents: 3876 diff changeset	520 {
7336 745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe] jwe parents: 7017 diff changeset	521 symbol_table::print_info (os, local_scope);
3933 f9ea3dcf58ee [project @ 2002-05-15 03:21:00 by jwe] jwe parents: 3876 diff changeset	522 }
7336 745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe] jwe parents: 7017 diff changeset	523 #endif
3933 f9ea3dcf58ee [project @ 2002-05-15 03:21:00 by jwe] jwe parents: 3876 diff changeset	524
f9ea3dcf58ee [project @ 2002-05-15 03:21:00 by jwe] jwe parents: 3876 diff changeset	525 void
2974 ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	526 octave_user_function::print_code_function_header (void)
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	527 {
5794 1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe] jwe parents: 5775 diff changeset	528 tree_print_code tpc (octave_stdout, VPS4);
2974 ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	529
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	530 tpc.visit_octave_user_function_header (*this);
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	531 }
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	532
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	533 void
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	534 octave_user_function::print_code_function_trailer (void)
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	535 {
5794 1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe] jwe parents: 5775 diff changeset	536 tree_print_code tpc (octave_stdout, VPS4);
2974 ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	537
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	538 tpc.visit_octave_user_function_trailer (*this);
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	539 }
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	540
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	541 void
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	542 octave_user_function::bind_automatic_vars
3974 e2290bf911f0 [project @ 2002-07-04 17:38:22 by jwe] jwe parents: 3933 diff changeset	543 (const string_vector& arg_names, int nargin, int nargout,
10832 1b2fcd122c6a allow user detect ignored outputs in m-functions Jaroslav Hajek <highegg@gmail.com> parents: 10637 diff changeset	544 const octave_value_list& va_args, const std::list<octave_lvalue> *lvalue_list)
2974 ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	545 {
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	546 if (! arg_names.empty ())
11557 e9d72a3caa46 mark automatic variables as automatic John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	547 {
11558 1e4dfc7a9487 use .argn. to store argument names for inputname function John W. Eaton <jwe@octave.org> parents: 11557 diff changeset	548 // It is better to save this in the hidden variable .argn. and
1e4dfc7a9487 use .argn. to store argument names for inputname function John W. Eaton <jwe@octave.org> parents: 11557 diff changeset	549 // then use that in the inputname function instead of using argn,
1e4dfc7a9487 use .argn. to store argument names for inputname function John W. Eaton <jwe@octave.org> parents: 11557 diff changeset	550 // which might be redefined in a function. Keep the old argn name
1e4dfc7a9487 use .argn. to store argument names for inputname function John W. Eaton <jwe@octave.org> parents: 11557 diff changeset	551 // for backward compatibility of functions that use it directly.
1e4dfc7a9487 use .argn. to store argument names for inputname function John W. Eaton <jwe@octave.org> parents: 11557 diff changeset	552
11557 e9d72a3caa46 mark automatic variables as automatic John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	553 symbol_table::varref ("argn") = arg_names;
11558 1e4dfc7a9487 use .argn. to store argument names for inputname function John W. Eaton <jwe@octave.org> parents: 11557 diff changeset	554 symbol_table::varref (".argn.") = Cell (arg_names);
1e4dfc7a9487 use .argn. to store argument names for inputname function John W. Eaton <jwe@octave.org> parents: 11557 diff changeset	555
1e4dfc7a9487 use .argn. to store argument names for inputname function John W. Eaton <jwe@octave.org> parents: 11557 diff changeset	556 symbol_table::mark_hidden (".argn.");
11557 e9d72a3caa46 mark automatic variables as automatic John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	557
e9d72a3caa46 mark automatic variables as automatic John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	558 symbol_table::mark_automatic ("argn");
11558 1e4dfc7a9487 use .argn. to store argument names for inputname function John W. Eaton <jwe@octave.org> parents: 11557 diff changeset	559 symbol_table::mark_automatic (".argn.");
11557 e9d72a3caa46 mark automatic variables as automatic John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	560 }
2974 ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	561
7336 745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe] jwe parents: 7017 diff changeset	562 symbol_table::varref (".nargin.") = nargin;
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe] jwe parents: 7017 diff changeset	563 symbol_table::varref (".nargout.") = nargout;
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe] jwe parents: 7017 diff changeset	564
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe] jwe parents: 7017 diff changeset	565 symbol_table::mark_hidden (".nargin.");
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe] jwe parents: 7017 diff changeset	566 symbol_table::mark_hidden (".nargout.");
3974 e2290bf911f0 [project @ 2002-07-04 17:38:22 by jwe] jwe parents: 3933 diff changeset	567
11557 e9d72a3caa46 mark automatic variables as automatic John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	568 symbol_table::mark_automatic (".nargin.");
e9d72a3caa46 mark automatic variables as automatic John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	569 symbol_table::mark_automatic (".nargout.");
e9d72a3caa46 mark automatic variables as automatic John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	570
3974 e2290bf911f0 [project @ 2002-07-04 17:38:22 by jwe] jwe parents: 3933 diff changeset	571 if (takes_varargs ())
8580 188d38a553c7 further indexing optimization touches Jaroslav Hajek <highegg@gmail.com> parents: 8142 diff changeset	572 symbol_table::varref ("varargin") = va_args.cell_value ();
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11558 diff changeset	573
10832 1b2fcd122c6a allow user detect ignored outputs in m-functions Jaroslav Hajek <highegg@gmail.com> parents: 10637 diff changeset	574 if (lvalue_list)
1b2fcd122c6a allow user detect ignored outputs in m-functions Jaroslav Hajek <highegg@gmail.com> parents: 10637 diff changeset	575 {
1b2fcd122c6a allow user detect ignored outputs in m-functions Jaroslav Hajek <highegg@gmail.com> parents: 10637 diff changeset	576 octave_idx_type nbh = 0;
1b2fcd122c6a allow user detect ignored outputs in m-functions Jaroslav Hajek <highegg@gmail.com> parents: 10637 diff changeset	577 for (std::list<octave_lvalue>::const_iterator p = lvalue_list->begin ();
1b2fcd122c6a allow user detect ignored outputs in m-functions Jaroslav Hajek <highegg@gmail.com> parents: 10637 diff changeset	578 p != lvalue_list->end (); p++)
1b2fcd122c6a allow user detect ignored outputs in m-functions Jaroslav Hajek <highegg@gmail.com> parents: 10637 diff changeset	579 nbh += p->is_black_hole ();
1b2fcd122c6a allow user detect ignored outputs in m-functions Jaroslav Hajek <highegg@gmail.com> parents: 10637 diff changeset	580
1b2fcd122c6a allow user detect ignored outputs in m-functions Jaroslav Hajek <highegg@gmail.com> parents: 10637 diff changeset	581 if (nbh > 0)
1b2fcd122c6a allow user detect ignored outputs in m-functions Jaroslav Hajek <highegg@gmail.com> parents: 10637 diff changeset	582 {
1b2fcd122c6a allow user detect ignored outputs in m-functions Jaroslav Hajek <highegg@gmail.com> parents: 10637 diff changeset	583 // Only assign the hidden variable if black holes actually present.
1b2fcd122c6a allow user detect ignored outputs in m-functions Jaroslav Hajek <highegg@gmail.com> parents: 10637 diff changeset	584 Matrix bh (1, nbh);
1b2fcd122c6a allow user detect ignored outputs in m-functions Jaroslav Hajek <highegg@gmail.com> parents: 10637 diff changeset	585 octave_idx_type k = 0, l = 0;
1b2fcd122c6a allow user detect ignored outputs in m-functions Jaroslav Hajek <highegg@gmail.com> parents: 10637 diff changeset	586 for (std::list<octave_lvalue>::const_iterator p = lvalue_list->begin ();
1b2fcd122c6a allow user detect ignored outputs in m-functions Jaroslav Hajek <highegg@gmail.com> parents: 10637 diff changeset	587 p != lvalue_list->end (); p++)
1b2fcd122c6a allow user detect ignored outputs in m-functions Jaroslav Hajek <highegg@gmail.com> parents: 10637 diff changeset	588 {
1b2fcd122c6a allow user detect ignored outputs in m-functions Jaroslav Hajek <highegg@gmail.com> parents: 10637 diff changeset	589 if (p->is_black_hole ())
1b2fcd122c6a allow user detect ignored outputs in m-functions Jaroslav Hajek <highegg@gmail.com> parents: 10637 diff changeset	590 bh(l++) = k+1;
1b2fcd122c6a allow user detect ignored outputs in m-functions Jaroslav Hajek <highegg@gmail.com> parents: 10637 diff changeset	591 k += p->numel ();
1b2fcd122c6a allow user detect ignored outputs in m-functions Jaroslav Hajek <highegg@gmail.com> parents: 10637 diff changeset	592 }
1b2fcd122c6a allow user detect ignored outputs in m-functions Jaroslav Hajek <highegg@gmail.com> parents: 10637 diff changeset	593
1b2fcd122c6a allow user detect ignored outputs in m-functions Jaroslav Hajek <highegg@gmail.com> parents: 10637 diff changeset	594 symbol_table::varref (".ignored.") = bh;
11557 e9d72a3caa46 mark automatic variables as automatic John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	595
10832 1b2fcd122c6a allow user detect ignored outputs in m-functions Jaroslav Hajek <highegg@gmail.com> parents: 10637 diff changeset	596 symbol_table::mark_hidden (".ignored.");
11557 e9d72a3caa46 mark automatic variables as automatic John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	597 symbol_table::mark_automatic (".ignored.");
10832 1b2fcd122c6a allow user detect ignored outputs in m-functions Jaroslav Hajek <highegg@gmail.com> parents: 10637 diff changeset	598 }
1b2fcd122c6a allow user detect ignored outputs in m-functions Jaroslav Hajek <highegg@gmail.com> parents: 10637 diff changeset	599 }
2974 ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	600 }
ebbc34ff7f66 [project @ 1997-05-15 19:36:16 by jwe] jwe parents: diff changeset	601
4700 ca3a1d687bba [project @ 2004-01-21 03:28:31 by jwe] jwe parents: 4645 diff changeset	602 DEFUN (nargin, args, ,
ca3a1d687bba [project @ 2004-01-21 03:28:31 by jwe] jwe parents: 4645 diff changeset	603 "-- texinfo --\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10832 diff changeset	604 @deftypefn {Built-in Function} {} nargin ()\n\
14136 20cb178716ee Make nargin and nargout behave more like Matlab's (Bug #32700) Iain Murray <iain@iainmurray.net> parents: 12483 diff changeset	605 @deftypefnx {Built-in Function} {} nargin (@var{fcn})\n\
4700 ca3a1d687bba [project @ 2004-01-21 03:28:31 by jwe] jwe parents: 4645 diff changeset	606 Within a function, return the number of arguments passed to the function.\n\
ca3a1d687bba [project @ 2004-01-21 03:28:31 by jwe] jwe parents: 4645 diff changeset	607 At the top level, return the number of command line arguments passed to\n\
14136 20cb178716ee Make nargin and nargout behave more like Matlab's (Bug #32700) Iain Murray <iain@iainmurray.net> parents: 12483 diff changeset	608 Octave.\n\
20cb178716ee Make nargin and nargout behave more like Matlab's (Bug #32700) Iain Murray <iain@iainmurray.net> parents: 12483 diff changeset	609 \n\
20cb178716ee Make nargin and nargout behave more like Matlab's (Bug #32700) Iain Murray <iain@iainmurray.net> parents: 12483 diff changeset	610 If called with the optional argument @var{fcn}, a function name or handle,\n\
20cb178716ee Make nargin and nargout behave more like Matlab's (Bug #32700) Iain Murray <iain@iainmurray.net> parents: 12483 diff changeset	611 return the declared number of arguments that the function can accept.\n\
20cb178716ee Make nargin and nargout behave more like Matlab's (Bug #32700) Iain Murray <iain@iainmurray.net> parents: 12483 diff changeset	612 If the last argument is @var{varargin} the returned value is negative.\n\
20cb178716ee Make nargin and nargout behave more like Matlab's (Bug #32700) Iain Murray <iain@iainmurray.net> parents: 12483 diff changeset	613 This feature does not work on builtin functions.\n\
5642 2618a0750ae6 [project @ 2006-03-06 21:26:48 by jwe] jwe parents: 5339 diff changeset	614 @seealso{nargout, varargin, varargout}\n\
4700 ca3a1d687bba [project @ 2004-01-21 03:28:31 by jwe] jwe parents: 4645 diff changeset	615 @end deftypefn")
ca3a1d687bba [project @ 2004-01-21 03:28:31 by jwe] jwe parents: 4645 diff changeset	616 {
ca3a1d687bba [project @ 2004-01-21 03:28:31 by jwe] jwe parents: 4645 diff changeset	617 octave_value retval;
ca3a1d687bba [project @ 2004-01-21 03:28:31 by jwe] jwe parents: 4645 diff changeset	618
ca3a1d687bba [project @ 2004-01-21 03:28:31 by jwe] jwe parents: 4645 diff changeset	619 int nargin = args.length ();
ca3a1d687bba [project @ 2004-01-21 03:28:31 by jwe] jwe parents: 4645 diff changeset	620
ca3a1d687bba [project @ 2004-01-21 03:28:31 by jwe] jwe parents: 4645 diff changeset	621 if (nargin == 1)
ca3a1d687bba [project @ 2004-01-21 03:28:31 by jwe] jwe parents: 4645 diff changeset	622 {
14136 20cb178716ee Make nargin and nargout behave more like Matlab's (Bug #32700) Iain Murray <iain@iainmurray.net> parents: 12483 diff changeset	623 octave_value func = args(0);
4700 ca3a1d687bba [project @ 2004-01-21 03:28:31 by jwe] jwe parents: 4645 diff changeset	624
14136 20cb178716ee Make nargin and nargout behave more like Matlab's (Bug #32700) Iain Murray <iain@iainmurray.net> parents: 12483 diff changeset	625 if (func.is_string ())
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	626 {
14136 20cb178716ee Make nargin and nargout behave more like Matlab's (Bug #32700) Iain Murray <iain@iainmurray.net> parents: 12483 diff changeset	627 std::string name = func.string_value ();
20cb178716ee Make nargin and nargout behave more like Matlab's (Bug #32700) Iain Murray <iain@iainmurray.net> parents: 12483 diff changeset	628 func = symbol_table::find_function (name);
20cb178716ee Make nargin and nargout behave more like Matlab's (Bug #32700) Iain Murray <iain@iainmurray.net> parents: 12483 diff changeset	629 if (func.is_undefined ())
20cb178716ee Make nargin and nargout behave more like Matlab's (Bug #32700) Iain Murray <iain@iainmurray.net> parents: 12483 diff changeset	630 error ("nargout: invalid function name: %s", name.c_str ());
20cb178716ee Make nargin and nargout behave more like Matlab's (Bug #32700) Iain Murray <iain@iainmurray.net> parents: 12483 diff changeset	631 }
4930 bdb307dc8613 [project @ 2004-08-05 04:55:26 by jwe] jwe parents: 4929 diff changeset	632
14136 20cb178716ee Make nargin and nargout behave more like Matlab's (Bug #32700) Iain Murray <iain@iainmurray.net> parents: 12483 diff changeset	633 octave_function *fcn_val = func.function_value ();
20cb178716ee Make nargin and nargout behave more like Matlab's (Bug #32700) Iain Murray <iain@iainmurray.net> parents: 12483 diff changeset	634 if (fcn_val)
20cb178716ee Make nargin and nargout behave more like Matlab's (Bug #32700) Iain Murray <iain@iainmurray.net> parents: 12483 diff changeset	635 {
20cb178716ee Make nargin and nargout behave more like Matlab's (Bug #32700) Iain Murray <iain@iainmurray.net> parents: 12483 diff changeset	636 octave_user_function *fcn = fcn_val->user_function_value (true);
4700 ca3a1d687bba [project @ 2004-01-21 03:28:31 by jwe] jwe parents: 4645 diff changeset	637
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	638 if (fcn)
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	639 {
14136 20cb178716ee Make nargin and nargout behave more like Matlab's (Bug #32700) Iain Murray <iain@iainmurray.net> parents: 12483 diff changeset	640 tree_parameter_list *param_list = fcn->parameter_list ();
20cb178716ee Make nargin and nargout behave more like Matlab's (Bug #32700) Iain Murray <iain@iainmurray.net> parents: 12483 diff changeset	641
20cb178716ee Make nargin and nargout behave more like Matlab's (Bug #32700) Iain Murray <iain@iainmurray.net> parents: 12483 diff changeset	642 retval = param_list ? param_list->length () : 0;
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	643 if (fcn->takes_varargs ())
14136 20cb178716ee Make nargin and nargout behave more like Matlab's (Bug #32700) Iain Murray <iain@iainmurray.net> parents: 12483 diff changeset	644 retval = -1 - retval;
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	645 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	646 else
14136 20cb178716ee Make nargin and nargout behave more like Matlab's (Bug #32700) Iain Murray <iain@iainmurray.net> parents: 12483 diff changeset	647 {
20cb178716ee Make nargin and nargout behave more like Matlab's (Bug #32700) Iain Murray <iain@iainmurray.net> parents: 12483 diff changeset	648 // Matlab gives up for histc, so maybe it's ok we give up somtimes too.
20cb178716ee Make nargin and nargout behave more like Matlab's (Bug #32700) Iain Murray <iain@iainmurray.net> parents: 12483 diff changeset	649 error ("nargin: nargin information not available for builtin functions");
20cb178716ee Make nargin and nargout behave more like Matlab's (Bug #32700) Iain Murray <iain@iainmurray.net> parents: 12483 diff changeset	650 }
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	651 }
4700 ca3a1d687bba [project @ 2004-01-21 03:28:31 by jwe] jwe parents: 4645 diff changeset	652 else
14136 20cb178716ee Make nargin and nargout behave more like Matlab's (Bug #32700) Iain Murray <iain@iainmurray.net> parents: 12483 diff changeset	653 error ("nargin: FCN must be a string or function handle");
4700 ca3a1d687bba [project @ 2004-01-21 03:28:31 by jwe] jwe parents: 4645 diff changeset	654 }
ca3a1d687bba [project @ 2004-01-21 03:28:31 by jwe] jwe parents: 4645 diff changeset	655 else if (nargin == 0)
ca3a1d687bba [project @ 2004-01-21 03:28:31 by jwe] jwe parents: 4645 diff changeset	656 {
7336 745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe] jwe parents: 7017 diff changeset	657 retval = symbol_table::varval (".nargin.");
4700 ca3a1d687bba [project @ 2004-01-21 03:28:31 by jwe] jwe parents: 4645 diff changeset	658
7336 745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe] jwe parents: 7017 diff changeset	659 if (retval.is_undefined ())
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	660 retval = 0;
4700 ca3a1d687bba [project @ 2004-01-21 03:28:31 by jwe] jwe parents: 4645 diff changeset	661 }
ca3a1d687bba [project @ 2004-01-21 03:28:31 by jwe] jwe parents: 4645 diff changeset	662 else
5823 080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe] jwe parents: 5794 diff changeset	663 print_usage ();
4700 ca3a1d687bba [project @ 2004-01-21 03:28:31 by jwe] jwe parents: 4645 diff changeset	664
ca3a1d687bba [project @ 2004-01-21 03:28:31 by jwe] jwe parents: 4645 diff changeset	665 return retval;
ca3a1d687bba [project @ 2004-01-21 03:28:31 by jwe] jwe parents: 4645 diff changeset	666 }
ca3a1d687bba [project @ 2004-01-21 03:28:31 by jwe] jwe parents: 4645 diff changeset	667
ca3a1d687bba [project @ 2004-01-21 03:28:31 by jwe] jwe parents: 4645 diff changeset	668 DEFUN (nargout, args, ,
ca3a1d687bba [project @ 2004-01-21 03:28:31 by jwe] jwe parents: 4645 diff changeset	669 "-- texinfo --\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10832 diff changeset	670 @deftypefn {Built-in Function} {} nargout ()\n\
14136 20cb178716ee Make nargin and nargout behave more like Matlab's (Bug #32700) Iain Murray <iain@iainmurray.net> parents: 12483 diff changeset	671 @deftypefnx {Built-in Function} {} nargout (@var{fcn})\n\
4700 ca3a1d687bba [project @ 2004-01-21 03:28:31 by jwe] jwe parents: 4645 diff changeset	672 Within a function, return the number of values the caller expects to\n\
14136 20cb178716ee Make nargin and nargout behave more like Matlab's (Bug #32700) Iain Murray <iain@iainmurray.net> parents: 12483 diff changeset	673 receive. If called with the optional argument @var{fcn}, a function\n\
20cb178716ee Make nargin and nargout behave more like Matlab's (Bug #32700) Iain Murray <iain@iainmurray.net> parents: 12483 diff changeset	674 name or handle, return the number of declared output values that the\n\
20cb178716ee Make nargin and nargout behave more like Matlab's (Bug #32700) Iain Murray <iain@iainmurray.net> parents: 12483 diff changeset	675 function can produce. If the final output argument is @var{varargout}\n\
20cb178716ee Make nargin and nargout behave more like Matlab's (Bug #32700) Iain Murray <iain@iainmurray.net> parents: 12483 diff changeset	676 the returned value is negative.\n\
4700 ca3a1d687bba [project @ 2004-01-21 03:28:31 by jwe] jwe parents: 4645 diff changeset	677 \n\
ca3a1d687bba [project @ 2004-01-21 03:28:31 by jwe] jwe parents: 4645 diff changeset	678 For example,\n\
ca3a1d687bba [project @ 2004-01-21 03:28:31 by jwe] jwe parents: 4645 diff changeset	679 \n\
ca3a1d687bba [project @ 2004-01-21 03:28:31 by jwe] jwe parents: 4645 diff changeset	680 @example\n\
ca3a1d687bba [project @ 2004-01-21 03:28:31 by jwe] jwe parents: 4645 diff changeset	681 f ()\n\
ca3a1d687bba [project @ 2004-01-21 03:28:31 by jwe] jwe parents: 4645 diff changeset	682 @end example\n\
ca3a1d687bba [project @ 2004-01-21 03:28:31 by jwe] jwe parents: 4645 diff changeset	683 \n\
ca3a1d687bba [project @ 2004-01-21 03:28:31 by jwe] jwe parents: 4645 diff changeset	684 @noindent\n\
4704 e1b71baef20c [project @ 2004-01-22 04:03:21 by jwe] jwe parents: 4700 diff changeset	685 will cause @code{nargout} to return 0 inside the function @code{f} and\n\
4700 ca3a1d687bba [project @ 2004-01-21 03:28:31 by jwe] jwe parents: 4645 diff changeset	686 \n\
ca3a1d687bba [project @ 2004-01-21 03:28:31 by jwe] jwe parents: 4645 diff changeset	687 @example\n\
ca3a1d687bba [project @ 2004-01-21 03:28:31 by jwe] jwe parents: 4645 diff changeset	688 [s, t] = f ()\n\
ca3a1d687bba [project @ 2004-01-21 03:28:31 by jwe] jwe parents: 4645 diff changeset	689 @end example\n\
ca3a1d687bba [project @ 2004-01-21 03:28:31 by jwe] jwe parents: 4645 diff changeset	690 \n\
ca3a1d687bba [project @ 2004-01-21 03:28:31 by jwe] jwe parents: 4645 diff changeset	691 @noindent\n\
ca3a1d687bba [project @ 2004-01-21 03:28:31 by jwe] jwe parents: 4645 diff changeset	692 will cause @code{nargout} to return 2 inside the function\n\
ca3a1d687bba [project @ 2004-01-21 03:28:31 by jwe] jwe parents: 4645 diff changeset	693 @code{f}.\n\
ca3a1d687bba [project @ 2004-01-21 03:28:31 by jwe] jwe parents: 4645 diff changeset	694 \n\
14136 20cb178716ee Make nargin and nargout behave more like Matlab's (Bug #32700) Iain Murray <iain@iainmurray.net> parents: 12483 diff changeset	695 In the second usage,\n\
20cb178716ee Make nargin and nargout behave more like Matlab's (Bug #32700) Iain Murray <iain@iainmurray.net> parents: 12483 diff changeset	696 \n\
20cb178716ee Make nargin and nargout behave more like Matlab's (Bug #32700) Iain Murray <iain@iainmurray.net> parents: 12483 diff changeset	697 @example\n\
20cb178716ee Make nargin and nargout behave more like Matlab's (Bug #32700) Iain Murray <iain@iainmurray.net> parents: 12483 diff changeset	698 nargout (@@histc) \% or nargout ('histc')\n\
20cb178716ee Make nargin and nargout behave more like Matlab's (Bug #32700) Iain Murray <iain@iainmurray.net> parents: 12483 diff changeset	699 @end example\n\
20cb178716ee Make nargin and nargout behave more like Matlab's (Bug #32700) Iain Murray <iain@iainmurray.net> parents: 12483 diff changeset	700 \n\
20cb178716ee Make nargin and nargout behave more like Matlab's (Bug #32700) Iain Murray <iain@iainmurray.net> parents: 12483 diff changeset	701 will return 2, because @code{histc} has two outputs, whereas\n\
20cb178716ee Make nargin and nargout behave more like Matlab's (Bug #32700) Iain Murray <iain@iainmurray.net> parents: 12483 diff changeset	702 \n\
20cb178716ee Make nargin and nargout behave more like Matlab's (Bug #32700) Iain Murray <iain@iainmurray.net> parents: 12483 diff changeset	703 @example\n\
20cb178716ee Make nargin and nargout behave more like Matlab's (Bug #32700) Iain Murray <iain@iainmurray.net> parents: 12483 diff changeset	704 nargout (@@deal)\n\
20cb178716ee Make nargin and nargout behave more like Matlab's (Bug #32700) Iain Murray <iain@iainmurray.net> parents: 12483 diff changeset	705 @end example\n\
20cb178716ee Make nargin and nargout behave more like Matlab's (Bug #32700) Iain Murray <iain@iainmurray.net> parents: 12483 diff changeset	706 \n\
20cb178716ee Make nargin and nargout behave more like Matlab's (Bug #32700) Iain Murray <iain@iainmurray.net> parents: 12483 diff changeset	707 will return -1, because @code{deal} has a variable number of outputs.\n\
20cb178716ee Make nargin and nargout behave more like Matlab's (Bug #32700) Iain Murray <iain@iainmurray.net> parents: 12483 diff changeset	708 \n\
20cb178716ee Make nargin and nargout behave more like Matlab's (Bug #32700) Iain Murray <iain@iainmurray.net> parents: 12483 diff changeset	709 At the top level, @code{nargout} with no argument is undefined.\n\
20cb178716ee Make nargin and nargout behave more like Matlab's (Bug #32700) Iain Murray <iain@iainmurray.net> parents: 12483 diff changeset	710 @code{nargout} does not work on builtin functions.\n\
20cb178716ee Make nargin and nargout behave more like Matlab's (Bug #32700) Iain Murray <iain@iainmurray.net> parents: 12483 diff changeset	711 @code{nargout} returns -1 for all anonymous functions.\n\
5642 2618a0750ae6 [project @ 2006-03-06 21:26:48 by jwe] jwe parents: 5339 diff changeset	712 @seealso{nargin, varargin, varargout}\n\
4700 ca3a1d687bba [project @ 2004-01-21 03:28:31 by jwe] jwe parents: 4645 diff changeset	713 @end deftypefn")
ca3a1d687bba [project @ 2004-01-21 03:28:31 by jwe] jwe parents: 4645 diff changeset	714 {
ca3a1d687bba [project @ 2004-01-21 03:28:31 by jwe] jwe parents: 4645 diff changeset	715 octave_value retval;
ca3a1d687bba [project @ 2004-01-21 03:28:31 by jwe] jwe parents: 4645 diff changeset	716
ca3a1d687bba [project @ 2004-01-21 03:28:31 by jwe] jwe parents: 4645 diff changeset	717 int nargin = args.length ();
ca3a1d687bba [project @ 2004-01-21 03:28:31 by jwe] jwe parents: 4645 diff changeset	718
ca3a1d687bba [project @ 2004-01-21 03:28:31 by jwe] jwe parents: 4645 diff changeset	719 if (nargin == 1)
ca3a1d687bba [project @ 2004-01-21 03:28:31 by jwe] jwe parents: 4645 diff changeset	720 {
14136 20cb178716ee Make nargin and nargout behave more like Matlab's (Bug #32700) Iain Murray <iain@iainmurray.net> parents: 12483 diff changeset	721 octave_value func = args(0);
4700 ca3a1d687bba [project @ 2004-01-21 03:28:31 by jwe] jwe parents: 4645 diff changeset	722
14136 20cb178716ee Make nargin and nargout behave more like Matlab's (Bug #32700) Iain Murray <iain@iainmurray.net> parents: 12483 diff changeset	723 if (func.is_string ())
20cb178716ee Make nargin and nargout behave more like Matlab's (Bug #32700) Iain Murray <iain@iainmurray.net> parents: 12483 diff changeset	724 {
20cb178716ee Make nargin and nargout behave more like Matlab's (Bug #32700) Iain Murray <iain@iainmurray.net> parents: 12483 diff changeset	725 std::string name = func.string_value ();
20cb178716ee Make nargin and nargout behave more like Matlab's (Bug #32700) Iain Murray <iain@iainmurray.net> parents: 12483 diff changeset	726 func = symbol_table::find_function (name);
20cb178716ee Make nargin and nargout behave more like Matlab's (Bug #32700) Iain Murray <iain@iainmurray.net> parents: 12483 diff changeset	727 if (func.is_undefined ())
20cb178716ee Make nargin and nargout behave more like Matlab's (Bug #32700) Iain Murray <iain@iainmurray.net> parents: 12483 diff changeset	728 error ("nargout: invalid function name: %s", name.c_str ());
20cb178716ee Make nargin and nargout behave more like Matlab's (Bug #32700) Iain Murray <iain@iainmurray.net> parents: 12483 diff changeset	729 }
20cb178716ee Make nargin and nargout behave more like Matlab's (Bug #32700) Iain Murray <iain@iainmurray.net> parents: 12483 diff changeset	730
20cb178716ee Make nargin and nargout behave more like Matlab's (Bug #32700) Iain Murray <iain@iainmurray.net> parents: 12483 diff changeset	731 if (func.is_inline_function ())
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	732 {
14136 20cb178716ee Make nargin and nargout behave more like Matlab's (Bug #32700) Iain Murray <iain@iainmurray.net> parents: 12483 diff changeset	733 retval = 1;
20cb178716ee Make nargin and nargout behave more like Matlab's (Bug #32700) Iain Murray <iain@iainmurray.net> parents: 12483 diff changeset	734 return retval;
20cb178716ee Make nargin and nargout behave more like Matlab's (Bug #32700) Iain Murray <iain@iainmurray.net> parents: 12483 diff changeset	735 }
20cb178716ee Make nargin and nargout behave more like Matlab's (Bug #32700) Iain Murray <iain@iainmurray.net> parents: 12483 diff changeset	736
20cb178716ee Make nargin and nargout behave more like Matlab's (Bug #32700) Iain Murray <iain@iainmurray.net> parents: 12483 diff changeset	737 if (func.is_function_handle ())
20cb178716ee Make nargin and nargout behave more like Matlab's (Bug #32700) Iain Murray <iain@iainmurray.net> parents: 12483 diff changeset	738 {
20cb178716ee Make nargin and nargout behave more like Matlab's (Bug #32700) Iain Murray <iain@iainmurray.net> parents: 12483 diff changeset	739 octave_fcn_handle *fh = func.fcn_handle_value ();
20cb178716ee Make nargin and nargout behave more like Matlab's (Bug #32700) Iain Murray <iain@iainmurray.net> parents: 12483 diff changeset	740 std::string fh_nm = fh->fcn_name ();
4930 bdb307dc8613 [project @ 2004-08-05 04:55:26 by jwe] jwe parents: 4929 diff changeset	741
14136 20cb178716ee Make nargin and nargout behave more like Matlab's (Bug #32700) Iain Murray <iain@iainmurray.net> parents: 12483 diff changeset	742 if (fh_nm == octave_fcn_handle::anonymous)
20cb178716ee Make nargin and nargout behave more like Matlab's (Bug #32700) Iain Murray <iain@iainmurray.net> parents: 12483 diff changeset	743 {
20cb178716ee Make nargin and nargout behave more like Matlab's (Bug #32700) Iain Murray <iain@iainmurray.net> parents: 12483 diff changeset	744 retval = -1;
20cb178716ee Make nargin and nargout behave more like Matlab's (Bug #32700) Iain Murray <iain@iainmurray.net> parents: 12483 diff changeset	745 return retval;
20cb178716ee Make nargin and nargout behave more like Matlab's (Bug #32700) Iain Murray <iain@iainmurray.net> parents: 12483 diff changeset	746 }
20cb178716ee Make nargin and nargout behave more like Matlab's (Bug #32700) Iain Murray <iain@iainmurray.net> parents: 12483 diff changeset	747 }
20cb178716ee Make nargin and nargout behave more like Matlab's (Bug #32700) Iain Murray <iain@iainmurray.net> parents: 12483 diff changeset	748
20cb178716ee Make nargin and nargout behave more like Matlab's (Bug #32700) Iain Murray <iain@iainmurray.net> parents: 12483 diff changeset	749 octave_function *fcn_val = func.function_value ();
20cb178716ee Make nargin and nargout behave more like Matlab's (Bug #32700) Iain Murray <iain@iainmurray.net> parents: 12483 diff changeset	750 if (fcn_val)
20cb178716ee Make nargin and nargout behave more like Matlab's (Bug #32700) Iain Murray <iain@iainmurray.net> parents: 12483 diff changeset	751 {
20cb178716ee Make nargin and nargout behave more like Matlab's (Bug #32700) Iain Murray <iain@iainmurray.net> parents: 12483 diff changeset	752 octave_user_function *fcn = fcn_val->user_function_value (true);
4700 ca3a1d687bba [project @ 2004-01-21 03:28:31 by jwe] jwe parents: 4645 diff changeset	753
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	754 if (fcn)
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	755 {
14136 20cb178716ee Make nargin and nargout behave more like Matlab's (Bug #32700) Iain Murray <iain@iainmurray.net> parents: 12483 diff changeset	756 tree_parameter_list *ret_list = fcn->return_list ();
20cb178716ee Make nargin and nargout behave more like Matlab's (Bug #32700) Iain Murray <iain@iainmurray.net> parents: 12483 diff changeset	757
20cb178716ee Make nargin and nargout behave more like Matlab's (Bug #32700) Iain Murray <iain@iainmurray.net> parents: 12483 diff changeset	758 retval = ret_list ? ret_list->length () : 0;
20cb178716ee Make nargin and nargout behave more like Matlab's (Bug #32700) Iain Murray <iain@iainmurray.net> parents: 12483 diff changeset	759
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	760 if (fcn->takes_var_return ())
14136 20cb178716ee Make nargin and nargout behave more like Matlab's (Bug #32700) Iain Murray <iain@iainmurray.net> parents: 12483 diff changeset	761 retval = -1 - retval;
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	762 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	763 else
14136 20cb178716ee Make nargin and nargout behave more like Matlab's (Bug #32700) Iain Murray <iain@iainmurray.net> parents: 12483 diff changeset	764 {
20cb178716ee Make nargin and nargout behave more like Matlab's (Bug #32700) Iain Murray <iain@iainmurray.net> parents: 12483 diff changeset	765 // JWE said this information is not available (currently, 2011-03-10)
20cb178716ee Make nargin and nargout behave more like Matlab's (Bug #32700) Iain Murray <iain@iainmurray.net> parents: 12483 diff changeset	766 // without making intrusive changes to Octave.
20cb178716ee Make nargin and nargout behave more like Matlab's (Bug #32700) Iain Murray <iain@iainmurray.net> parents: 12483 diff changeset	767 // Matlab gives up for histc, so maybe it's ok we give up somtimes too.
20cb178716ee Make nargin and nargout behave more like Matlab's (Bug #32700) Iain Murray <iain@iainmurray.net> parents: 12483 diff changeset	768 error ("nargout: nargout information not available for builtin functions.");
20cb178716ee Make nargin and nargout behave more like Matlab's (Bug #32700) Iain Murray <iain@iainmurray.net> parents: 12483 diff changeset	769 }
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	770 }
4700 ca3a1d687bba [project @ 2004-01-21 03:28:31 by jwe] jwe parents: 4645 diff changeset	771 else
14136 20cb178716ee Make nargin and nargout behave more like Matlab's (Bug #32700) Iain Murray <iain@iainmurray.net> parents: 12483 diff changeset	772 error ("nargout: FCN must be a string or function handle");
4700 ca3a1d687bba [project @ 2004-01-21 03:28:31 by jwe] jwe parents: 4645 diff changeset	773 }
ca3a1d687bba [project @ 2004-01-21 03:28:31 by jwe] jwe parents: 4645 diff changeset	774 else if (nargin == 0)
ca3a1d687bba [project @ 2004-01-21 03:28:31 by jwe] jwe parents: 4645 diff changeset	775 {
7336 745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe] jwe parents: 7017 diff changeset	776 if (! symbol_table::at_top_level ())
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	777 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	778 retval = symbol_table::varval (".nargout.");
4700 ca3a1d687bba [project @ 2004-01-21 03:28:31 by jwe] jwe parents: 4645 diff changeset	779
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	780 if (retval.is_undefined ())
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	781 retval = 0;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	782 }
4700 ca3a1d687bba [project @ 2004-01-21 03:28:31 by jwe] jwe parents: 4645 diff changeset	783 else
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	784 error ("nargout: invalid call at top level");
4700 ca3a1d687bba [project @ 2004-01-21 03:28:31 by jwe] jwe parents: 4645 diff changeset	785 }
ca3a1d687bba [project @ 2004-01-21 03:28:31 by jwe] jwe parents: 4645 diff changeset	786 else
5823 080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe] jwe parents: 5794 diff changeset	787 print_usage ();
4700 ca3a1d687bba [project @ 2004-01-21 03:28:31 by jwe] jwe parents: 4645 diff changeset	788
ca3a1d687bba [project @ 2004-01-21 03:28:31 by jwe] jwe parents: 4645 diff changeset	789 return retval;
ca3a1d687bba [project @ 2004-01-21 03:28:31 by jwe] jwe parents: 4645 diff changeset	790 }
ca3a1d687bba [project @ 2004-01-21 03:28:31 by jwe] jwe parents: 4645 diff changeset	791
9522 e79470be3ecb implement subsasgn this-arg optimization Jaroslav Hajek <highegg@gmail.com> parents: 9396 diff changeset	792 DEFUN (optimize_subsasgn_calls, args, nargout,
e79470be3ecb implement subsasgn this-arg optimization Jaroslav Hajek <highegg@gmail.com> parents: 9396 diff changeset	793 "-- texinfo --\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10832 diff changeset	794 @deftypefn {Built-in Function} {@var{val} =} optimize_subsasgn_calls ()\n\
89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10832 diff changeset	795 @deftypefnx {Built-in Function} {@var{old_val} =} optimize_subsasgn_calls (@var{new_val})\n\
9522 e79470be3ecb implement subsasgn this-arg optimization Jaroslav Hajek <highegg@gmail.com> parents: 9396 diff changeset	796 Query or set the internal flag for subsasgn method call optimizations.\n\
e79470be3ecb implement subsasgn this-arg optimization Jaroslav Hajek <highegg@gmail.com> parents: 9396 diff changeset	797 If true, Octave will attempt to eliminate the redundant copying when calling\n\
e79470be3ecb implement subsasgn this-arg optimization Jaroslav Hajek <highegg@gmail.com> parents: 9396 diff changeset	798 subsasgn method of a user-defined class.\n\
e79470be3ecb implement subsasgn this-arg optimization Jaroslav Hajek <highegg@gmail.com> parents: 9396 diff changeset	799 @end deftypefn")
e79470be3ecb implement subsasgn this-arg optimization Jaroslav Hajek <highegg@gmail.com> parents: 9396 diff changeset	800 {
e79470be3ecb implement subsasgn this-arg optimization Jaroslav Hajek <highegg@gmail.com> parents: 9396 diff changeset	801 return SET_INTERNAL_VARIABLE (optimize_subsasgn_calls);
e79470be3ecb implement subsasgn this-arg optimization Jaroslav Hajek <highegg@gmail.com> parents: 9396 diff changeset	802 }
10832 1b2fcd122c6a allow user detect ignored outputs in m-functions Jaroslav Hajek <highegg@gmail.com> parents: 10637 diff changeset	803
1b2fcd122c6a allow user detect ignored outputs in m-functions Jaroslav Hajek <highegg@gmail.com> parents: 10637 diff changeset	804 static bool val_in_table (const Matrix& table, double val)
1b2fcd122c6a allow user detect ignored outputs in m-functions Jaroslav Hajek <highegg@gmail.com> parents: 10637 diff changeset	805 {
1b2fcd122c6a allow user detect ignored outputs in m-functions Jaroslav Hajek <highegg@gmail.com> parents: 10637 diff changeset	806 if (table.is_empty ())
1b2fcd122c6a allow user detect ignored outputs in m-functions Jaroslav Hajek <highegg@gmail.com> parents: 10637 diff changeset	807 return false;
1b2fcd122c6a allow user detect ignored outputs in m-functions Jaroslav Hajek <highegg@gmail.com> parents: 10637 diff changeset	808
1b2fcd122c6a allow user detect ignored outputs in m-functions Jaroslav Hajek <highegg@gmail.com> parents: 10637 diff changeset	809 octave_idx_type i = table.lookup (val, ASCENDING);
1b2fcd122c6a allow user detect ignored outputs in m-functions Jaroslav Hajek <highegg@gmail.com> parents: 10637 diff changeset	810 return (i > 0 && table(i-1) == val);
1b2fcd122c6a allow user detect ignored outputs in m-functions Jaroslav Hajek <highegg@gmail.com> parents: 10637 diff changeset	811 }
1b2fcd122c6a allow user detect ignored outputs in m-functions Jaroslav Hajek <highegg@gmail.com> parents: 10637 diff changeset	812
10847 7fa3c8e43357 change is_ignored_output to isargout Jaroslav Hajek <highegg@gmail.com> parents: 10846 diff changeset	813 static bool isargout1 (int nargout, const Matrix& ignored, double k)
7fa3c8e43357 change is_ignored_output to isargout Jaroslav Hajek <highegg@gmail.com> parents: 10846 diff changeset	814 {
7fa3c8e43357 change is_ignored_output to isargout Jaroslav Hajek <highegg@gmail.com> parents: 10846 diff changeset	815 if (k != xround (k) \|\| k <= 0)
7fa3c8e43357 change is_ignored_output to isargout Jaroslav Hajek <highegg@gmail.com> parents: 10846 diff changeset	816 {
12483 7a5aacf65f81 Rewrite error strings in src/ to use variables named in documentation. Rik <octave@nomad.inbox5.com> parents: 11586 diff changeset	817 error ("isargout: K must be a positive integer");
10847 7fa3c8e43357 change is_ignored_output to isargout Jaroslav Hajek <highegg@gmail.com> parents: 10846 diff changeset	818 return false;
7fa3c8e43357 change is_ignored_output to isargout Jaroslav Hajek <highegg@gmail.com> parents: 10846 diff changeset	819 }
7fa3c8e43357 change is_ignored_output to isargout Jaroslav Hajek <highegg@gmail.com> parents: 10846 diff changeset	820 else
7fa3c8e43357 change is_ignored_output to isargout Jaroslav Hajek <highegg@gmail.com> parents: 10846 diff changeset	821 return (k == 1 \|\| k <= nargout) && ! val_in_table (ignored, k);
7fa3c8e43357 change is_ignored_output to isargout Jaroslav Hajek <highegg@gmail.com> parents: 10846 diff changeset	822 }
7fa3c8e43357 change is_ignored_output to isargout Jaroslav Hajek <highegg@gmail.com> parents: 10846 diff changeset	823
7fa3c8e43357 change is_ignored_output to isargout Jaroslav Hajek <highegg@gmail.com> parents: 10846 diff changeset	824 DEFUN (isargout, args, ,
10832 1b2fcd122c6a allow user detect ignored outputs in m-functions Jaroslav Hajek <highegg@gmail.com> parents: 10637 diff changeset	825 "-- texinfo --\n\
10847 7fa3c8e43357 change is_ignored_output to isargout Jaroslav Hajek <highegg@gmail.com> parents: 10846 diff changeset	826 @deftypefn {Built-in Function} {} isargout (@var{k})\n\
11431 0d9640d755b1 Improve docstrings for all isXXX functions. Rik <octave@nomad.inbox5.com> parents: 11304 diff changeset	827 Within a function, return a logical value indicating whether the argument\n\
0d9640d755b1 Improve docstrings for all isXXX functions. Rik <octave@nomad.inbox5.com> parents: 11304 diff changeset	828 @var{k} will be assigned on output to a variable. If the result is false,\n\
0d9640d755b1 Improve docstrings for all isXXX functions. Rik <octave@nomad.inbox5.com> parents: 11304 diff changeset	829 the argument has been ignored during the function call through the use of\n\
0d9640d755b1 Improve docstrings for all isXXX functions. Rik <octave@nomad.inbox5.com> parents: 11304 diff changeset	830 the tilde (~) special output argument. Functions can use @code{isargout} to\n\
0d9640d755b1 Improve docstrings for all isXXX functions. Rik <octave@nomad.inbox5.com> parents: 11304 diff changeset	831 avoid performing unnecessary calculations for outputs which are unwanted.\n\
0d9640d755b1 Improve docstrings for all isXXX functions. Rik <octave@nomad.inbox5.com> parents: 11304 diff changeset	832 \n\
0d9640d755b1 Improve docstrings for all isXXX functions. Rik <octave@nomad.inbox5.com> parents: 11304 diff changeset	833 If @var{k} is outside the range @code{1:max(nargout)}, the function returns\n\
0d9640d755b1 Improve docstrings for all isXXX functions. Rik <octave@nomad.inbox5.com> parents: 11304 diff changeset	834 false. @var{k} can also be an array, in which case the function works\n\
0d9640d755b1 Improve docstrings for all isXXX functions. Rik <octave@nomad.inbox5.com> parents: 11304 diff changeset	835 element-by-element and a logical array is returned. At the top level,\n\
0d9640d755b1 Improve docstrings for all isXXX functions. Rik <octave@nomad.inbox5.com> parents: 11304 diff changeset	836 @code{isargout} returns an error.\n\
10832 1b2fcd122c6a allow user detect ignored outputs in m-functions Jaroslav Hajek <highegg@gmail.com> parents: 10637 diff changeset	837 @seealso{nargout, nargin, varargin, varargout}\n\
1b2fcd122c6a allow user detect ignored outputs in m-functions Jaroslav Hajek <highegg@gmail.com> parents: 10637 diff changeset	838 @end deftypefn")
1b2fcd122c6a allow user detect ignored outputs in m-functions Jaroslav Hajek <highegg@gmail.com> parents: 10637 diff changeset	839 {
1b2fcd122c6a allow user detect ignored outputs in m-functions Jaroslav Hajek <highegg@gmail.com> parents: 10637 diff changeset	840 octave_value retval;
1b2fcd122c6a allow user detect ignored outputs in m-functions Jaroslav Hajek <highegg@gmail.com> parents: 10637 diff changeset	841
1b2fcd122c6a allow user detect ignored outputs in m-functions Jaroslav Hajek <highegg@gmail.com> parents: 10637 diff changeset	842 int nargin = args.length ();
1b2fcd122c6a allow user detect ignored outputs in m-functions Jaroslav Hajek <highegg@gmail.com> parents: 10637 diff changeset	843
1b2fcd122c6a allow user detect ignored outputs in m-functions Jaroslav Hajek <highegg@gmail.com> parents: 10637 diff changeset	844 if (nargin == 1)
1b2fcd122c6a allow user detect ignored outputs in m-functions Jaroslav Hajek <highegg@gmail.com> parents: 10637 diff changeset	845 {
1b2fcd122c6a allow user detect ignored outputs in m-functions Jaroslav Hajek <highegg@gmail.com> parents: 10637 diff changeset	846 if (! symbol_table::at_top_level ())
1b2fcd122c6a allow user detect ignored outputs in m-functions Jaroslav Hajek <highegg@gmail.com> parents: 10637 diff changeset	847 {
10847 7fa3c8e43357 change is_ignored_output to isargout Jaroslav Hajek <highegg@gmail.com> parents: 10846 diff changeset	848 int nargout1 = symbol_table::varval (".nargout.").int_value ();
7fa3c8e43357 change is_ignored_output to isargout Jaroslav Hajek <highegg@gmail.com> parents: 10846 diff changeset	849 if (error_state)
7fa3c8e43357 change is_ignored_output to isargout Jaroslav Hajek <highegg@gmail.com> parents: 10846 diff changeset	850 {
7fa3c8e43357 change is_ignored_output to isargout Jaroslav Hajek <highegg@gmail.com> parents: 10846 diff changeset	851 error ("isargout: internal error");
7fa3c8e43357 change is_ignored_output to isargout Jaroslav Hajek <highegg@gmail.com> parents: 10846 diff changeset	852 return retval;
7fa3c8e43357 change is_ignored_output to isargout Jaroslav Hajek <highegg@gmail.com> parents: 10846 diff changeset	853 }
7fa3c8e43357 change is_ignored_output to isargout Jaroslav Hajek <highegg@gmail.com> parents: 10846 diff changeset	854
10832 1b2fcd122c6a allow user detect ignored outputs in m-functions Jaroslav Hajek <highegg@gmail.com> parents: 10637 diff changeset	855 Matrix ignored;
1b2fcd122c6a allow user detect ignored outputs in m-functions Jaroslav Hajek <highegg@gmail.com> parents: 10637 diff changeset	856 octave_value tmp = symbol_table::varval (".ignored.");
1b2fcd122c6a allow user detect ignored outputs in m-functions Jaroslav Hajek <highegg@gmail.com> parents: 10637 diff changeset	857 if (tmp.is_defined ())
1b2fcd122c6a allow user detect ignored outputs in m-functions Jaroslav Hajek <highegg@gmail.com> parents: 10637 diff changeset	858 ignored = tmp.matrix_value ();
1b2fcd122c6a allow user detect ignored outputs in m-functions Jaroslav Hajek <highegg@gmail.com> parents: 10637 diff changeset	859
1b2fcd122c6a allow user detect ignored outputs in m-functions Jaroslav Hajek <highegg@gmail.com> parents: 10637 diff changeset	860 if (args(0).is_scalar_type ())
1b2fcd122c6a allow user detect ignored outputs in m-functions Jaroslav Hajek <highegg@gmail.com> parents: 10637 diff changeset	861 {
1b2fcd122c6a allow user detect ignored outputs in m-functions Jaroslav Hajek <highegg@gmail.com> parents: 10637 diff changeset	862 double k = args(0).double_value ();
1b2fcd122c6a allow user detect ignored outputs in m-functions Jaroslav Hajek <highegg@gmail.com> parents: 10637 diff changeset	863 if (! error_state)
10847 7fa3c8e43357 change is_ignored_output to isargout Jaroslav Hajek <highegg@gmail.com> parents: 10846 diff changeset	864 retval = isargout1 (nargout1, ignored, k);
10832 1b2fcd122c6a allow user detect ignored outputs in m-functions Jaroslav Hajek <highegg@gmail.com> parents: 10637 diff changeset	865 }
1b2fcd122c6a allow user detect ignored outputs in m-functions Jaroslav Hajek <highegg@gmail.com> parents: 10637 diff changeset	866 else if (args(0).is_numeric_type ())
1b2fcd122c6a allow user detect ignored outputs in m-functions Jaroslav Hajek <highegg@gmail.com> parents: 10637 diff changeset	867 {
1b2fcd122c6a allow user detect ignored outputs in m-functions Jaroslav Hajek <highegg@gmail.com> parents: 10637 diff changeset	868 const NDArray ka = args(0).array_value ();
1b2fcd122c6a allow user detect ignored outputs in m-functions Jaroslav Hajek <highegg@gmail.com> parents: 10637 diff changeset	869 if (! error_state)
1b2fcd122c6a allow user detect ignored outputs in m-functions Jaroslav Hajek <highegg@gmail.com> parents: 10637 diff changeset	870 {
1b2fcd122c6a allow user detect ignored outputs in m-functions Jaroslav Hajek <highegg@gmail.com> parents: 10637 diff changeset	871 boolNDArray r (ka.dims ());
10847 7fa3c8e43357 change is_ignored_output to isargout Jaroslav Hajek <highegg@gmail.com> parents: 10846 diff changeset	872 for (octave_idx_type i = 0; i < ka.numel () && ! error_state; i++)
7fa3c8e43357 change is_ignored_output to isargout Jaroslav Hajek <highegg@gmail.com> parents: 10846 diff changeset	873 r(i) = isargout1 (nargout1, ignored, ka(i));
10832 1b2fcd122c6a allow user detect ignored outputs in m-functions Jaroslav Hajek <highegg@gmail.com> parents: 10637 diff changeset	874
1b2fcd122c6a allow user detect ignored outputs in m-functions Jaroslav Hajek <highegg@gmail.com> parents: 10637 diff changeset	875 retval = r;
1b2fcd122c6a allow user detect ignored outputs in m-functions Jaroslav Hajek <highegg@gmail.com> parents: 10637 diff changeset	876 }
1b2fcd122c6a allow user detect ignored outputs in m-functions Jaroslav Hajek <highegg@gmail.com> parents: 10637 diff changeset	877 }
1b2fcd122c6a allow user detect ignored outputs in m-functions Jaroslav Hajek <highegg@gmail.com> parents: 10637 diff changeset	878 else
10847 7fa3c8e43357 change is_ignored_output to isargout Jaroslav Hajek <highegg@gmail.com> parents: 10846 diff changeset	879 gripe_wrong_type_arg ("isargout", args(0));
10832 1b2fcd122c6a allow user detect ignored outputs in m-functions Jaroslav Hajek <highegg@gmail.com> parents: 10637 diff changeset	880 }
1b2fcd122c6a allow user detect ignored outputs in m-functions Jaroslav Hajek <highegg@gmail.com> parents: 10637 diff changeset	881 else
10847 7fa3c8e43357 change is_ignored_output to isargout Jaroslav Hajek <highegg@gmail.com> parents: 10846 diff changeset	882 error ("isargout: invalid call at top level");
10832 1b2fcd122c6a allow user detect ignored outputs in m-functions Jaroslav Hajek <highegg@gmail.com> parents: 10637 diff changeset	883 }
1b2fcd122c6a allow user detect ignored outputs in m-functions Jaroslav Hajek <highegg@gmail.com> parents: 10637 diff changeset	884 else
1b2fcd122c6a allow user detect ignored outputs in m-functions Jaroslav Hajek <highegg@gmail.com> parents: 10637 diff changeset	885 print_usage ();
1b2fcd122c6a allow user detect ignored outputs in m-functions Jaroslav Hajek <highegg@gmail.com> parents: 10637 diff changeset	886
1b2fcd122c6a allow user detect ignored outputs in m-functions Jaroslav Hajek <highegg@gmail.com> parents: 10637 diff changeset	887 return retval;
1b2fcd122c6a allow user detect ignored outputs in m-functions Jaroslav Hajek <highegg@gmail.com> parents: 10637 diff changeset	888 }

Mercurial > hg > octave-lyh

annotate src/ov-usr-fcn.cc @ 14136:20cb178716ee