|
2974
|
1 /* |
|
|
2 |
|
|
3 Copyright (C) 1996, 1997 John W. Eaton |
|
|
4 |
|
|
5 This file is part of Octave. |
|
|
6 |
|
|
7 Octave is free software; you can redistribute it and/or modify it |
|
|
8 under the terms of the GNU General Public License as published by the |
|
|
9 Free Software Foundation; either version 2, or (at your option) any |
|
|
10 later version. |
|
|
11 |
|
|
12 Octave is distributed in the hope that it will be useful, but WITHOUT |
|
|
13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
|
|
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
|
|
15 for more details. |
|
|
16 |
|
|
17 You should have received a copy of the GNU General Public License |
|
|
18 along with Octave; see the file COPYING. If not, write to the Free |
|
|
19 Software Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. |
|
|
20 |
|
|
21 */ |
|
|
22 |
|
4192
|
23 #if defined (__GNUG__) && defined (USE_PRAGMA_INTERFACE_IMPLEMENTATION) |
|
2974
|
24 #pragma implementation |
|
|
25 #endif |
|
|
26 |
|
|
27 #ifdef HAVE_CONFIG_H |
|
|
28 #include <config.h> |
|
|
29 #endif |
|
|
30 |
|
|
31 #include "str-vec.h" |
|
|
32 |
|
|
33 #include <defaults.h> |
|
3974
|
34 #include "Cell.h" |
|
2974
|
35 #include "defun.h" |
|
|
36 #include "error.h" |
|
|
37 #include "input.h" |
|
|
38 #include "oct-obj.h" |
|
|
39 #include "ov-usr-fcn.h" |
|
|
40 #include "ov.h" |
|
|
41 #include "pager.h" |
|
2985
|
42 #include "pt-jump.h" |
|
2974
|
43 #include "pt-misc.h" |
|
|
44 #include "pt-pr-code.h" |
|
2982
|
45 #include "pt-stmt.h" |
|
2974
|
46 #include "pt-walk.h" |
|
|
47 #include "symtab.h" |
|
|
48 #include "toplev.h" |
|
|
49 #include "unwind-prot.h" |
|
|
50 #include "utils.h" |
|
3489
|
51 #include "parse.h" |
|
2974
|
52 #include "variables.h" |
|
|
53 |
|
3131
|
54 // Maximum nesting level for functions called recursively. |
|
|
55 static int Vmax_recursion_depth; |
|
|
56 |
|
2974
|
57 // User defined functions. |
|
|
58 |
|
3219
|
59 DEFINE_OCTAVE_ALLOCATOR (octave_user_function); |
|
2974
|
60 |
|
3219
|
61 DEFINE_OV_TYPEID_FUNCTIONS_AND_DATA (octave_user_function, |
|
4612
|
62 "user-defined function", |
|
3219
|
63 "user-defined function"); |
|
2974
|
64 |
|
|
65 // Ugh. This really needs to be simplified (code/data? |
|
|
66 // extrinsic/intrinsic state?). |
|
|
67 |
|
|
68 octave_user_function::octave_user_function |
|
|
69 (tree_parameter_list *pl, tree_parameter_list *rl, |
|
|
70 tree_statement_list *cl, symbol_table *st) |
|
3523
|
71 : octave_function (std::string (), std::string ()), |
|
2974
|
72 param_list (pl), ret_list (rl), cmd_list (cl), |
|
4748
|
73 sym_tab (st), lead_comm (), trail_comm (), file_name (), |
|
3255
|
74 t_parsed (static_cast<time_t> (0)), |
|
|
75 t_checked (static_cast<time_t> (0)), |
|
|
76 system_fcn_file (false), call_depth (0), |
|
4238
|
77 num_named_args (0), nested_function (false), |
|
|
78 args_passed (), num_args_passed (0), |
|
3165
|
79 curr_va_arg_number (0), vr_list (0), symtab_entry (0), |
|
3974
|
80 argn_sr (0), nargin_sr (0), nargout_sr (0), varargin_sr (0) |
|
2974
|
81 { |
|
|
82 if (param_list) |
|
|
83 { |
|
|
84 num_named_args = param_list->length (); |
|
|
85 curr_va_arg_number = num_named_args; |
|
|
86 } |
|
|
87 } |
|
|
88 |
|
|
89 octave_user_function::~octave_user_function (void) |
|
|
90 { |
|
|
91 delete param_list; |
|
|
92 delete ret_list; |
|
|
93 delete sym_tab; |
|
|
94 delete cmd_list; |
|
|
95 delete vr_list; |
|
3665
|
96 delete lead_comm; |
|
|
97 delete trail_comm; |
|
2974
|
98 } |
|
|
99 |
|
|
100 octave_user_function * |
|
|
101 octave_user_function::define_ret_list (tree_parameter_list *t) |
|
|
102 { |
|
|
103 ret_list = t; |
|
|
104 |
|
|
105 if (ret_list && ret_list->takes_varargs ()) |
|
|
106 vr_list = new tree_va_return_list; |
|
|
107 |
|
|
108 return this; |
|
|
109 } |
|
|
110 |
|
|
111 void |
|
4343
|
112 octave_user_function::stash_fcn_file_name (const std::string& nm) |
|
2974
|
113 { |
|
4343
|
114 file_name = nm; |
|
2974
|
115 } |
|
|
116 |
|
|
117 void |
|
|
118 octave_user_function::mark_as_system_fcn_file (void) |
|
|
119 { |
|
|
120 if (! file_name.empty ()) |
|
|
121 { |
|
|
122 // We really should stash the whole path to the file we found, |
|
|
123 // when we looked it up, to avoid possible race conditions... |
|
|
124 // XXX FIXME XXX |
|
|
125 // |
|
|
126 // We probably also don't need to get the library directory |
|
|
127 // every time, but since this function is only called when the |
|
|
128 // function file is parsed, it probably doesn't matter that |
|
|
129 // much. |
|
|
130 |
|
3523
|
131 std::string ff_name = fcn_file_in_path (file_name); |
|
2974
|
132 |
|
3565
|
133 if (Vfcn_file_dir == ff_name.substr (0, Vfcn_file_dir.length ())) |
|
2974
|
134 system_fcn_file = 1; |
|
|
135 } |
|
|
136 else |
|
|
137 system_fcn_file = 0; |
|
|
138 } |
|
|
139 |
|
|
140 bool |
|
|
141 octave_user_function::takes_varargs (void) const |
|
|
142 { |
|
|
143 return (param_list && param_list->takes_varargs ()); |
|
|
144 } |
|
|
145 |
|
|
146 octave_value |
|
|
147 octave_user_function::octave_va_arg (void) |
|
|
148 { |
|
|
149 octave_value retval; |
|
|
150 |
|
|
151 if (curr_va_arg_number < num_args_passed) |
|
|
152 retval = args_passed (curr_va_arg_number++); |
|
|
153 else |
|
|
154 ::error ("va_arg: error getting arg number %d -- only %d provided", |
|
|
155 curr_va_arg_number + 1, num_args_passed); |
|
|
156 |
|
|
157 return retval; |
|
|
158 } |
|
|
159 |
|
|
160 octave_value_list |
|
|
161 octave_user_function::octave_all_va_args (void) |
|
|
162 { |
|
|
163 octave_value_list retval; |
|
|
164 |
|
3178
|
165 int n = num_args_passed - num_named_args; |
|
2974
|
166 |
|
3178
|
167 if (n > 0) |
|
|
168 { |
|
|
169 retval.resize (n); |
|
|
170 |
|
|
171 int k = 0; |
|
|
172 for (int i = num_named_args; i < num_args_passed; i++) |
|
|
173 retval(k++) = args_passed(i); |
|
|
174 } |
|
2974
|
175 |
|
|
176 return retval; |
|
|
177 } |
|
|
178 |
|
|
179 bool |
|
|
180 octave_user_function::takes_var_return (void) const |
|
|
181 { |
|
|
182 return (ret_list && ret_list->takes_varargs ()); |
|
|
183 } |
|
|
184 |
|
|
185 void |
|
|
186 octave_user_function::octave_vr_val (const octave_value& val) |
|
|
187 { |
|
4280
|
188 // Use != here to avoid possible conversion to int of smaller type |
|
|
189 // than the vr_list pointer. |
|
|
190 |
|
|
191 assert (vr_list != 0); |
|
2974
|
192 |
|
|
193 vr_list->append (val); |
|
|
194 } |
|
|
195 |
|
|
196 void |
|
3974
|
197 octave_user_function::varargout_to_vr_val (void) |
|
|
198 { |
|
|
199 assert (vr_list && vr_list->empty ()); |
|
|
200 |
|
|
201 symbol_record *sr = sym_tab->lookup ("varargout"); |
|
|
202 |
|
|
203 if (sr && sr->is_variable ()) |
|
|
204 { |
|
|
205 octave_value v = sr->def (); |
|
|
206 |
|
|
207 Cell c = v.cell_value (); |
|
|
208 |
|
|
209 if (! error_state) |
|
|
210 { |
|
|
211 // XXX FIXME XXX -- should varargout be required to be a |
|
|
212 // cell array with a single row or column? If not, should |
|
|
213 // we have a cleaner way of doing this operation? |
|
|
214 |
|
|
215 int n = c.length (); |
|
|
216 |
|
|
217 const octave_value *d = c.data (); |
|
|
218 |
|
|
219 for (int i = 0; i < n; i++) |
|
|
220 vr_list->append (d[i]); |
|
|
221 } |
|
|
222 else |
|
|
223 error ("expecting varargout to be a cell array object"); |
|
|
224 } |
|
|
225 } |
|
|
226 |
|
|
227 bool |
|
|
228 octave_user_function::has_varargout (void) const |
|
|
229 { |
|
|
230 bool retval = false; |
|
|
231 |
|
|
232 if (takes_var_return ()) |
|
|
233 { |
|
|
234 symbol_record *sr = sym_tab->lookup ("varargout"); |
|
|
235 |
|
|
236 retval = (sr && sr->is_variable ()); |
|
|
237 } |
|
|
238 |
|
|
239 return retval; |
|
|
240 } |
|
|
241 |
|
2974
|
242 // For unwind protect. |
|
|
243 |
|
|
244 static void |
|
|
245 pop_symbol_table_context (void *table) |
|
|
246 { |
|
|
247 symbol_table *tmp = static_cast<symbol_table *> (table); |
|
|
248 tmp->pop_context (); |
|
|
249 } |
|
|
250 |
|
|
251 static void |
|
|
252 delete_vr_list (void *list) |
|
|
253 { |
|
|
254 tree_va_return_list *tmp = static_cast<tree_va_return_list *> (list); |
|
|
255 tmp->clear (); |
|
|
256 delete tmp; |
|
|
257 } |
|
|
258 |
|
|
259 static void |
|
|
260 clear_symbol_table (void *table) |
|
|
261 { |
|
|
262 symbol_table *tmp = static_cast<symbol_table *> (table); |
|
4239
|
263 tmp->clear (); |
|
2974
|
264 } |
|
|
265 |
|
|
266 static void |
|
3239
|
267 clear_param_list (void *lst) |
|
|
268 { |
|
|
269 tree_parameter_list *tmp = static_cast<tree_parameter_list *> (lst); |
|
|
270 |
|
|
271 if (tmp) |
|
4219
|
272 tmp->undefine (); |
|
3239
|
273 } |
|
|
274 |
|
|
275 static void |
|
3875
|
276 restore_args_passed (void *fcn) |
|
3239
|
277 { |
|
|
278 octave_user_function *tmp = static_cast<octave_user_function *> (fcn); |
|
|
279 |
|
|
280 if (tmp) |
|
3875
|
281 tmp->restore_args_passed (); |
|
3239
|
282 } |
|
|
283 |
|
|
284 static void |
|
2974
|
285 unprotect_function (void *sr_arg) |
|
|
286 { |
|
|
287 symbol_record *sr = static_cast<symbol_record *> (sr_arg); |
|
|
288 sr->unprotect (); |
|
|
289 } |
|
|
290 |
|
|
291 octave_value_list |
|
4247
|
292 octave_user_function::subsref (const std::string& type, |
|
4219
|
293 const std::list<octave_value_list>& idx, |
|
3933
|
294 int nargout) |
|
|
295 { |
|
|
296 octave_value_list retval; |
|
|
297 |
|
|
298 switch (type[0]) |
|
|
299 { |
|
|
300 case '(': |
|
|
301 retval = do_multi_index_op (nargout, idx.front ()); |
|
|
302 break; |
|
|
303 |
|
|
304 case '{': |
|
|
305 case '.': |
|
|
306 { |
|
|
307 std::string nm = type_name (); |
|
|
308 error ("%s cannot be indexed with %c", nm.c_str (), type[0]); |
|
|
309 } |
|
|
310 break; |
|
|
311 |
|
|
312 default: |
|
|
313 panic_impossible (); |
|
|
314 } |
|
|
315 |
|
4059
|
316 // XXX FIXME XXX -- perhaps there should be an |
|
|
317 // octave_value_list::next_subsref member function? See also |
|
|
318 // octave_builtin::subsref. |
|
3933
|
319 |
|
4219
|
320 if (idx.size () > 1) |
|
4059
|
321 retval = retval(0).next_subsref (type, idx); |
|
|
322 |
|
|
323 return retval; |
|
3933
|
324 } |
|
|
325 |
|
|
326 octave_value_list |
|
3544
|
327 octave_user_function::do_multi_index_op (int nargout, |
|
|
328 const octave_value_list& args) |
|
2974
|
329 { |
|
|
330 octave_value_list retval; |
|
|
331 |
|
|
332 if (error_state) |
|
|
333 return retval; |
|
|
334 |
|
|
335 if (! cmd_list) |
|
|
336 return retval; |
|
|
337 |
|
|
338 int nargin = args.length (); |
|
|
339 |
|
2985
|
340 unwind_protect::begin_frame ("func_eval"); |
|
2974
|
341 |
|
|
342 unwind_protect_int (call_depth); |
|
|
343 call_depth++; |
|
|
344 |
|
3131
|
345 if (call_depth > Vmax_recursion_depth) |
|
|
346 { |
|
|
347 ::error ("max_recursion_limit exceeded"); |
|
3321
|
348 unwind_protect::run_frame ("func_eval"); |
|
3131
|
349 return retval; |
|
|
350 } |
|
|
351 |
|
2974
|
352 if (symtab_entry && ! symtab_entry->is_read_only ()) |
|
|
353 { |
|
|
354 symtab_entry->protect (); |
|
2985
|
355 unwind_protect::add (unprotect_function, symtab_entry); |
|
2974
|
356 } |
|
|
357 |
|
|
358 if (call_depth > 1) |
|
|
359 { |
|
|
360 sym_tab->push_context (); |
|
2985
|
361 unwind_protect::add (pop_symbol_table_context, sym_tab); |
|
2974
|
362 |
|
|
363 if (vr_list) |
|
|
364 { |
|
|
365 // Push new vr_list. |
|
|
366 |
|
|
367 unwind_protect_ptr (vr_list); |
|
|
368 vr_list = new tree_va_return_list; |
|
|
369 |
|
|
370 // Clear and delete the new one before restoring the old |
|
|
371 // one. |
|
|
372 |
|
2985
|
373 unwind_protect::add (delete_vr_list, vr_list); |
|
2974
|
374 } |
|
|
375 } |
|
|
376 |
|
|
377 if (vr_list) |
|
|
378 vr_list->clear (); |
|
|
379 |
|
4929
|
380 install_automatic_vars (); |
|
|
381 |
|
2974
|
382 // Force symbols to be undefined again when this function exits. |
|
|
383 |
|
2985
|
384 unwind_protect::add (clear_symbol_table, sym_tab); |
|
2974
|
385 |
|
|
386 // Save old and set current symbol table context, for |
|
|
387 // eval_undefined_error(). |
|
|
388 |
|
4245
|
389 unwind_protect_ptr (curr_caller_sym_tab); |
|
|
390 curr_caller_sym_tab = curr_sym_tab; |
|
|
391 |
|
2974
|
392 unwind_protect_ptr (curr_sym_tab); |
|
|
393 curr_sym_tab = sym_tab; |
|
|
394 |
|
|
395 unwind_protect_ptr (curr_function); |
|
|
396 curr_function = this; |
|
|
397 |
|
4238
|
398 if (! is_nested_function ()) |
|
|
399 { |
|
|
400 unwind_protect_ptr (curr_parent_function); |
|
|
401 curr_parent_function = this; |
|
|
402 } |
|
|
403 |
|
3875
|
404 // Save and restore args passed for recursive calls. |
|
2974
|
405 |
|
3875
|
406 save_args_passed (args); |
|
3239
|
407 |
|
3875
|
408 unwind_protect::add (::restore_args_passed, this); |
|
3239
|
409 |
|
2974
|
410 string_vector arg_names = args.name_tags (); |
|
|
411 |
|
|
412 unwind_protect_int (num_args_passed); |
|
|
413 num_args_passed = nargin; |
|
|
414 |
|
|
415 unwind_protect_int (curr_va_arg_number); |
|
|
416 |
|
3876
|
417 curr_va_arg_number = num_named_args; |
|
|
418 |
|
2974
|
419 if (param_list && ! param_list->varargs_only ()) |
|
|
420 { |
|
|
421 param_list->define_from_arg_vector (args); |
|
|
422 if (error_state) |
|
|
423 goto abort; |
|
|
424 } |
|
|
425 |
|
3239
|
426 // Force parameter list to be undefined when this function exits. |
|
|
427 // Doing so decrements the reference counts on the values of local |
|
|
428 // variables that are also named function parameters. |
|
|
429 |
|
|
430 unwind_protect::add (clear_param_list, param_list); |
|
|
431 |
|
|
432 // Force return list to be undefined when this function exits. |
|
|
433 // Doing so decrements the reference counts on the values of local |
|
|
434 // variables that are also named values returned by this function. |
|
|
435 |
|
|
436 unwind_protect::add (clear_param_list, ret_list); |
|
|
437 |
|
2974
|
438 // The following code is in a separate scope to avoid warnings from |
|
|
439 // G++ about `goto abort' crossing the initialization of some |
|
|
440 // variables. |
|
|
441 |
|
|
442 { |
|
3974
|
443 bind_automatic_vars (arg_names, nargin, nargout, octave_all_va_args ()); |
|
2974
|
444 |
|
|
445 bool echo_commands = (Vecho_executing_commands & ECHO_FUNCTIONS); |
|
|
446 |
|
|
447 if (echo_commands) |
|
|
448 print_code_function_header (); |
|
|
449 |
|
|
450 // Evaluate the commands that make up the function. |
|
|
451 |
|
3489
|
452 unwind_protect_bool (evaluating_function_body); |
|
|
453 evaluating_function_body = true; |
|
|
454 |
|
2974
|
455 octave_value_list tmp = cmd_list->eval (); |
|
|
456 |
|
|
457 octave_value last_computed_value; |
|
|
458 |
|
|
459 if (! tmp.empty ()) |
|
|
460 last_computed_value = tmp(0); |
|
|
461 |
|
|
462 if (echo_commands) |
|
|
463 print_code_function_trailer (); |
|
|
464 |
|
4207
|
465 if (tree_return_command::returning) |
|
|
466 tree_return_command::returning = 0; |
|
2974
|
467 |
|
4207
|
468 if (tree_break_command::breaking) |
|
|
469 tree_break_command::breaking--; |
|
2974
|
470 |
|
|
471 if (error_state) |
|
|
472 { |
|
|
473 traceback_error (); |
|
|
474 goto abort; |
|
|
475 } |
|
|
476 |
|
|
477 // Copy return values out. |
|
|
478 |
|
|
479 if (ret_list) |
|
3871
|
480 { |
|
4748
|
481 ret_list->initialize_undefined_elements (my_name, nargout, Matrix ()); |
|
3871
|
482 |
|
3974
|
483 if (has_varargout ()) |
|
|
484 varargout_to_vr_val (); |
|
|
485 |
|
3871
|
486 retval = ret_list->convert_to_const_vector (vr_list); |
|
|
487 } |
|
2974
|
488 } |
|
|
489 |
|
|
490 abort: |
|
2985
|
491 unwind_protect::run_frame ("func_eval"); |
|
2974
|
492 |
|
|
493 return retval; |
|
|
494 } |
|
|
495 |
|
|
496 void |
|
4346
|
497 octave_user_function::traceback_error (void) const |
|
2974
|
498 { |
|
|
499 if (error_state >= 0) |
|
|
500 error_state = -1; |
|
|
501 |
|
4748
|
502 if (my_name.empty ()) |
|
2974
|
503 { |
|
|
504 if (file_name.empty ()) |
|
|
505 ::error ("called from `?unknown?'"); |
|
|
506 else |
|
|
507 ::error ("called from file `%s'", file_name.c_str ()); |
|
|
508 } |
|
|
509 else |
|
|
510 { |
|
|
511 if (file_name.empty ()) |
|
4748
|
512 ::error ("called from `%s'", my_name.c_str ()); |
|
2974
|
513 else |
|
|
514 ::error ("called from `%s' in file `%s'", |
|
4748
|
515 my_name.c_str (), file_name.c_str ()); |
|
2974
|
516 } |
|
|
517 } |
|
|
518 |
|
|
519 void |
|
|
520 octave_user_function::accept (tree_walker& tw) |
|
|
521 { |
|
|
522 tw.visit_octave_user_function (*this); |
|
|
523 } |
|
|
524 |
|
|
525 void |
|
3933
|
526 octave_user_function::print_symtab_info (std::ostream& os) const |
|
|
527 { |
|
|
528 if (sym_tab) |
|
|
529 sym_tab->print_info (os); |
|
|
530 else |
|
4748
|
531 warning ("%s: no symbol table info!", my_name.c_str ()); |
|
3933
|
532 } |
|
|
533 |
|
|
534 void |
|
2974
|
535 octave_user_function::print_code_function_header (void) |
|
|
536 { |
|
|
537 tree_print_code tpc (octave_stdout, Vps4); |
|
|
538 |
|
|
539 tpc.visit_octave_user_function_header (*this); |
|
|
540 } |
|
|
541 |
|
|
542 void |
|
|
543 octave_user_function::print_code_function_trailer (void) |
|
|
544 { |
|
|
545 tree_print_code tpc (octave_stdout, Vps4); |
|
|
546 |
|
|
547 tpc.visit_octave_user_function_trailer (*this); |
|
|
548 } |
|
|
549 |
|
|
550 void |
|
|
551 octave_user_function::install_automatic_vars (void) |
|
|
552 { |
|
4645
|
553 if (sym_tab) |
|
|
554 { |
|
|
555 argn_sr = sym_tab->lookup ("argn", true); |
|
4700
|
556 nargin_sr = sym_tab->lookup ("__nargin__", true); |
|
|
557 nargout_sr = sym_tab->lookup ("__nargout__", true); |
|
3974
|
558 |
|
4645
|
559 if (takes_varargs ()) |
|
4929
|
560 varargin_sr = sym_tab->lookup ("varargin", true); |
|
4645
|
561 } |
|
2974
|
562 } |
|
|
563 |
|
|
564 void |
|
|
565 octave_user_function::bind_automatic_vars |
|
3974
|
566 (const string_vector& arg_names, int nargin, int nargout, |
|
|
567 const octave_value_list& va_args) |
|
2974
|
568 { |
|
|
569 if (! arg_names.empty ()) |
|
|
570 argn_sr->define (arg_names); |
|
|
571 |
|
4233
|
572 nargin_sr->define (nargin); |
|
|
573 nargout_sr->define (nargout); |
|
3974
|
574 |
|
|
575 if (takes_varargs ()) |
|
|
576 { |
|
|
577 int n = va_args.length (); |
|
|
578 |
|
|
579 Cell varargin (1, n); |
|
|
580 |
|
|
581 for (int i = 0; i < n; i++) |
|
|
582 varargin(0,i) = va_args(i); |
|
|
583 |
|
|
584 varargin_sr->define (varargin); |
|
|
585 } |
|
2974
|
586 } |
|
|
587 |
|
4700
|
588 DEFUN (nargin, args, , |
|
|
589 "-*- texinfo -*-\n\ |
|
|
590 @deftypefn {Built-in Function} {} nargin ()\n\ |
|
|
591 @deftypefnx {Built-in Function} {} nargin (@var{fcn_name})\n\ |
|
|
592 Within a function, return the number of arguments passed to the function.\n\ |
|
|
593 At the top level, return the number of command line arguments passed to\n\ |
|
|
594 Octave. If called with the optional argument @var{fcn_name}, return the\n\ |
|
|
595 maximum number of arguments the named function can accept, or -1 if the\n\ |
|
|
596 function accepts a variable number of arguments.\n\ |
|
|
597 @end deftypefn") |
|
|
598 { |
|
|
599 octave_value retval; |
|
|
600 |
|
|
601 int nargin = args.length (); |
|
|
602 |
|
|
603 if (nargin == 1) |
|
|
604 { |
|
|
605 std::string fname = args(0).string_value (); |
|
|
606 |
|
|
607 if (! error_state) |
|
|
608 { |
|
4930
|
609 octave_value fcn_val = lookup_user_function (fname); |
|
|
610 |
|
|
611 octave_user_function *fcn = fcn_val.user_function_value (true); |
|
4700
|
612 |
|
|
613 if (fcn) |
|
|
614 { |
|
|
615 if (fcn->takes_varargs ()) |
|
|
616 retval = -1; |
|
|
617 else |
|
|
618 { |
|
|
619 tree_parameter_list *param_list = fcn->parameter_list (); |
|
|
620 |
|
|
621 retval = param_list ? param_list->length () : 0; |
|
|
622 } |
|
|
623 } |
|
|
624 else |
|
|
625 error ("nargin: invalid function"); |
|
|
626 } |
|
|
627 else |
|
|
628 error ("nargin: expecting string as first argument"); |
|
|
629 } |
|
|
630 else if (nargin == 0) |
|
|
631 { |
|
|
632 symbol_record *sr = curr_sym_tab->lookup ("__nargin__"); |
|
|
633 |
|
|
634 retval = sr ? sr->def () : 0; |
|
|
635 } |
|
|
636 else |
|
|
637 print_usage ("nargin"); |
|
|
638 |
|
|
639 return retval; |
|
|
640 } |
|
|
641 |
|
|
642 DEFUN (nargout, args, , |
|
|
643 "-*- texinfo -*-\n\ |
|
|
644 @deftypefn {Built-in Function} {} nargout ()\n\ |
|
|
645 @deftypefnx {Built-in Function} {} nargout (@var{fcn_name})\n\ |
|
|
646 Within a function, return the number of values the caller expects to\n\ |
|
|
647 receive. If called with the optional argument @var{fcn_name}, return the\n\ |
|
|
648 maximum number of values the named function can produce, or -1 if the\n\ |
|
|
649 function can produce a variable number of values.\n\ |
|
|
650 \n\ |
|
|
651 For example,\n\ |
|
|
652 \n\ |
|
|
653 @example\n\ |
|
|
654 f ()\n\ |
|
|
655 @end example\n\ |
|
|
656 \n\ |
|
|
657 @noindent\n\ |
|
4704
|
658 will cause @code{nargout} to return 0 inside the function @code{f} and\n\ |
|
4700
|
659 \n\ |
|
|
660 @example\n\ |
|
|
661 [s, t] = f ()\n\ |
|
|
662 @end example\n\ |
|
|
663 \n\ |
|
|
664 @noindent\n\ |
|
|
665 will cause @code{nargout} to return 2 inside the function\n\ |
|
|
666 @code{f}.\n\ |
|
|
667 \n\ |
|
|
668 At the top level, @code{nargout} is undefined.\n\ |
|
|
669 @end deftypefn") |
|
|
670 { |
|
|
671 octave_value retval; |
|
|
672 |
|
|
673 int nargin = args.length (); |
|
|
674 |
|
|
675 if (nargin == 1) |
|
|
676 { |
|
|
677 std::string fname = args(0).string_value (); |
|
|
678 |
|
|
679 if (! error_state) |
|
|
680 { |
|
4930
|
681 octave_value fcn_val = lookup_user_function (fname); |
|
|
682 |
|
|
683 octave_user_function *fcn = fcn_val.user_function_value (true); |
|
4700
|
684 |
|
|
685 if (fcn) |
|
|
686 { |
|
|
687 if (fcn->takes_var_return ()) |
|
|
688 retval = -1; |
|
|
689 else |
|
|
690 { |
|
|
691 tree_parameter_list *ret_list = fcn->return_list (); |
|
|
692 |
|
|
693 retval = ret_list ? ret_list->length () : 0; |
|
|
694 } |
|
|
695 } |
|
|
696 else |
|
|
697 error ("nargout: invalid function"); |
|
|
698 } |
|
|
699 else |
|
|
700 error ("nargout: expecting string as first argument"); |
|
|
701 } |
|
|
702 else if (nargin == 0) |
|
|
703 { |
|
|
704 if (! at_top_level ()) |
|
|
705 { |
|
|
706 symbol_record *sr = curr_sym_tab->lookup ("__nargout__"); |
|
|
707 |
|
|
708 retval = sr ? sr->def () : 0; |
|
|
709 } |
|
|
710 else |
|
|
711 error ("nargout: invalid call at top level"); |
|
|
712 } |
|
|
713 else |
|
|
714 print_usage ("nargout"); |
|
|
715 |
|
|
716 return retval; |
|
|
717 } |
|
|
718 |
|
3743
|
719 DEFUNX ("va_arg", Fva_arg, args, , |
|
3445
|
720 "-*- texinfo -*-\n\ |
|
|
721 @deftypefn {Built-in Function} {} va_arg ()\n\ |
|
3745
|
722 Return the value of the next available argument and move the internal\n\ |
|
3445
|
723 pointer to the next argument. It is an error to call @code{va_arg}\n\ |
|
|
724 when ther eare no more arguments available, or in a function that\n\ |
|
|
725 has not been declared to take a variable number of parameters.\n\ |
|
|
726 @end deftypefn") |
|
2974
|
727 { |
|
4124
|
728 static bool warned = false; |
|
|
729 |
|
|
730 if (! warned) |
|
|
731 { |
|
|
732 ::warning ("va_arg is deprecated; use varargin instead"); |
|
|
733 warned = true; |
|
|
734 } |
|
3975
|
735 |
|
2974
|
736 octave_value_list retval; |
|
|
737 |
|
|
738 int nargin = args.length (); |
|
|
739 |
|
|
740 if (nargin == 0) |
|
|
741 { |
|
|
742 if (curr_function) |
|
|
743 { |
|
|
744 if (curr_function->takes_varargs ()) |
|
|
745 retval = curr_function->octave_va_arg (); |
|
|
746 else |
|
|
747 { |
|
|
748 ::error ("va_arg only valid within function taking variable"); |
|
|
749 ::error ("number of arguments"); |
|
|
750 } |
|
|
751 } |
|
|
752 else |
|
|
753 ::error ("va_arg only valid within function body"); |
|
|
754 } |
|
|
755 else |
|
|
756 print_usage ("va_arg"); |
|
|
757 |
|
|
758 return retval; |
|
|
759 } |
|
|
760 |
|
|
761 DEFUN (va_start, args, , |
|
3445
|
762 "-*- texinfo -*-\n\ |
|
|
763 @deftypefn {Built-in Function} {} va_start ()\n\ |
|
|
764 Position an internal pointer to the first unnamed argument in\n\ |
|
|
765 functions that have been declared to accept a variable number of\n\ |
|
|
766 arguments. It is an error to call @code{va_start} in a function\n\ |
|
|
767 that has not been declared to take a variable number of parameters.\n\ |
|
|
768 @end deftypefn") |
|
2974
|
769 { |
|
4124
|
770 static bool warned = false; |
|
|
771 |
|
|
772 if (! warned) |
|
|
773 { |
|
|
774 ::warning ("va_start is deprecated; use varargin instead"); |
|
|
775 warned = true; |
|
|
776 } |
|
3975
|
777 |
|
2974
|
778 octave_value_list retval; |
|
|
779 |
|
|
780 int nargin = args.length (); |
|
|
781 |
|
|
782 if (nargin == 0) |
|
|
783 { |
|
|
784 if (curr_function) |
|
|
785 { |
|
|
786 if (curr_function->takes_varargs ()) |
|
|
787 curr_function->octave_va_start (); |
|
|
788 else |
|
|
789 { |
|
|
790 ::error ("va_start only valid within function taking variable"); |
|
|
791 ::error ("number of arguments"); |
|
|
792 } |
|
|
793 } |
|
|
794 else |
|
|
795 ::error ("va_start only valid within function body"); |
|
|
796 } |
|
|
797 else |
|
|
798 print_usage ("va_start"); |
|
|
799 |
|
|
800 return retval; |
|
|
801 } |
|
|
802 |
|
|
803 DEFUN (vr_val, args, , |
|
3445
|
804 "-*- texinfo -*-\n\ |
|
|
805 @deftypefn {Built-in Function} {} vr_val (@var{x})\n\ |
|
|
806 Each time this function is called, it places the value of its argument\n\ |
|
|
807 at the end of the list of values to return from the current\n\ |
|
|
808 function. Once @code{vr_val} has been called, there is no way to go\n\ |
|
|
809 back to the beginning of the list and rewrite any of the return\n\ |
|
|
810 values. This function may only be called within functions that have\n\ |
|
|
811 been declared to return an unspecified number of output arguments.\n\ |
|
|
812 @end deftypefn") |
|
2974
|
813 { |
|
4124
|
814 static bool warned = false; |
|
|
815 |
|
|
816 if (! warned) |
|
|
817 { |
|
|
818 ::warning ("vr_val is deprecated; use varargout instead"); |
|
|
819 warned = true; |
|
|
820 } |
|
3975
|
821 |
|
2974
|
822 octave_value_list retval; |
|
|
823 |
|
|
824 int nargin = args.length (); |
|
|
825 |
|
|
826 if (nargin == 1) |
|
|
827 { |
|
|
828 if (curr_function) |
|
|
829 { |
|
3974
|
830 if (curr_function->has_varargout ()) |
|
|
831 ::error ("vr_val and varargout cannot both be used in the same function"); |
|
|
832 else if (curr_function->takes_var_return ()) |
|
2974
|
833 curr_function->octave_vr_val (args(0)); |
|
|
834 else |
|
|
835 { |
|
|
836 ::error ("vr_val only valid within function declared to"); |
|
|
837 ::error ("produce a variable number of values"); |
|
|
838 } |
|
|
839 } |
|
|
840 else |
|
|
841 ::error ("vr_val only valid within function body"); |
|
|
842 } |
|
|
843 else |
|
|
844 print_usage ("vr_val"); |
|
|
845 |
|
|
846 return retval; |
|
|
847 } |
|
|
848 |
|
|
849 static int |
|
3131
|
850 max_recursion_depth (void) |
|
|
851 { |
|
|
852 Vmax_recursion_depth = check_preference ("max_recursion_depth"); |
|
|
853 |
|
|
854 return 0; |
|
|
855 } |
|
|
856 |
|
2974
|
857 void |
|
|
858 symbols_of_ov_usr_fcn (void) |
|
|
859 { |
|
3258
|
860 DEFVAR (max_recursion_depth, 256.0, max_recursion_depth, |
|
3371
|
861 "-*- texinfo -*-\n\ |
|
|
862 @defvr {Built-in Variable} max_recursion_depth\n\ |
|
|
863 Limit the number of times a function may be called recursively.\n\ |
|
|
864 If the limit is exceeded, an error message is printed and control\n\ |
|
|
865 returns to the top level.\n\ |
|
|
866 \n\ |
|
|
867 The default value is 256.\n\ |
|
|
868 @end defvr"); |
|
2974
|
869 } |
|
|
870 |
|
|
871 /* |
|
|
872 ;;; Local Variables: *** |
|
|
873 ;;; mode: C++ *** |
|
|
874 ;;; End: *** |
|
|
875 */ |
