annotate src/defun-int.h @ 1229:7d7c3eaa1d3b

[project @ 1995-04-10 01:04:13 by jwe]
author jwe
date Mon, 10 Apr 1995 01:04:46 +0000
parents dfe01093f657
children 611d403c7f3d
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
525
509e9a2d93a6 [project @ 1994-07-20 18:45:27 by jwe]
jwe
parents:
diff changeset
1 // defun-int.h -*- C++ -*-
509e9a2d93a6 [project @ 1994-07-20 18:45:27 by jwe]
jwe
parents:
diff changeset
2 /*
509e9a2d93a6 [project @ 1994-07-20 18:45:27 by jwe]
jwe
parents:
diff changeset
3
1009
dfe01093f657 [project @ 1995-01-04 04:05:12 by jwe]
jwe
parents: 712
diff changeset
4 Copyright (C) 1992, 1993, 1994, 1995 John W. Eaton
525
509e9a2d93a6 [project @ 1994-07-20 18:45:27 by jwe]
jwe
parents:
diff changeset
5
509e9a2d93a6 [project @ 1994-07-20 18:45:27 by jwe]
jwe
parents:
diff changeset
6 This file is part of Octave.
509e9a2d93a6 [project @ 1994-07-20 18:45:27 by jwe]
jwe
parents:
diff changeset
7
509e9a2d93a6 [project @ 1994-07-20 18:45:27 by jwe]
jwe
parents:
diff changeset
8 Octave is free software; you can redistribute it and/or modify it
509e9a2d93a6 [project @ 1994-07-20 18:45:27 by jwe]
jwe
parents:
diff changeset
9 under the terms of the GNU General Public License as published by the
509e9a2d93a6 [project @ 1994-07-20 18:45:27 by jwe]
jwe
parents:
diff changeset
10 Free Software Foundation; either version 2, or (at your option) any
509e9a2d93a6 [project @ 1994-07-20 18:45:27 by jwe]
jwe
parents:
diff changeset
11 later version.
509e9a2d93a6 [project @ 1994-07-20 18:45:27 by jwe]
jwe
parents:
diff changeset
12
509e9a2d93a6 [project @ 1994-07-20 18:45:27 by jwe]
jwe
parents:
diff changeset
13 Octave is distributed in the hope that it will be useful, but WITHOUT
509e9a2d93a6 [project @ 1994-07-20 18:45:27 by jwe]
jwe
parents:
diff changeset
14 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
509e9a2d93a6 [project @ 1994-07-20 18:45:27 by jwe]
jwe
parents:
diff changeset
15 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
509e9a2d93a6 [project @ 1994-07-20 18:45:27 by jwe]
jwe
parents:
diff changeset
16 for more details.
509e9a2d93a6 [project @ 1994-07-20 18:45:27 by jwe]
jwe
parents:
diff changeset
17
509e9a2d93a6 [project @ 1994-07-20 18:45:27 by jwe]
jwe
parents:
diff changeset
18 You should have received a copy of the GNU General Public License
509e9a2d93a6 [project @ 1994-07-20 18:45:27 by jwe]
jwe
parents:
diff changeset
19 along with Octave; see the file COPYING. If not, write to the Free
509e9a2d93a6 [project @ 1994-07-20 18:45:27 by jwe]
jwe
parents:
diff changeset
20 Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
509e9a2d93a6 [project @ 1994-07-20 18:45:27 by jwe]
jwe
parents:
diff changeset
21
509e9a2d93a6 [project @ 1994-07-20 18:45:27 by jwe]
jwe
parents:
diff changeset
22 */
509e9a2d93a6 [project @ 1994-07-20 18:45:27 by jwe]
jwe
parents:
diff changeset
23
509e9a2d93a6 [project @ 1994-07-20 18:45:27 by jwe]
jwe
parents:
diff changeset
24 #if !defined (octave_defun_int_h)
509e9a2d93a6 [project @ 1994-07-20 18:45:27 by jwe]
jwe
parents:
diff changeset
25 #define octave_defun_int_h 1
509e9a2d93a6 [project @ 1994-07-20 18:45:27 by jwe]
jwe
parents:
diff changeset
26
550
95ee5e330179 [project @ 1994-07-22 20:17:58 by jwe]
jwe
parents: 540
diff changeset
27 // MAKE_BUILTINS is defined to extract function names and related
95ee5e330179 [project @ 1994-07-22 20:17:58 by jwe]
jwe
parents: 540
diff changeset
28 // information and create the *.def files that are eventually used to
95ee5e330179 [project @ 1994-07-22 20:17:58 by jwe]
jwe
parents: 540
diff changeset
29 // create the buitlins.cc file.
95ee5e330179 [project @ 1994-07-22 20:17:58 by jwe]
jwe
parents: 540
diff changeset
30
525
509e9a2d93a6 [project @ 1994-07-20 18:45:27 by jwe]
jwe
parents:
diff changeset
31 #ifdef MAKE_BUILTINS
509e9a2d93a6 [project @ 1994-07-20 18:45:27 by jwe]
jwe
parents:
diff changeset
32
550
95ee5e330179 [project @ 1994-07-22 20:17:58 by jwe]
jwe
parents: 540
diff changeset
33 // Generate code to install name in the symbol table. The script
95ee5e330179 [project @ 1994-07-22 20:17:58 by jwe]
jwe
parents: 540
diff changeset
34 // mkdefs will create a .def file for every .cc file that uses DEFUN,
95ee5e330179 [project @ 1994-07-22 20:17:58 by jwe]
jwe
parents: 540
diff changeset
35 // DEFUN_TEXT, or DEFUN_DLD.
95ee5e330179 [project @ 1994-07-22 20:17:58 by jwe]
jwe
parents: 540
diff changeset
36
525
509e9a2d93a6 [project @ 1994-07-20 18:45:27 by jwe]
jwe
parents:
diff changeset
37 #define DEFUN_INTERNAL(name, fname, sname, nargin_max, nargout_max, \
509e9a2d93a6 [project @ 1994-07-20 18:45:27 by jwe]
jwe
parents:
diff changeset
38 is_text_fcn, doc) \
509e9a2d93a6 [project @ 1994-07-20 18:45:27 by jwe]
jwe
parents:
diff changeset
39 BEGIN_INSTALL_BUILTIN \
703
21cc5b9b9ed6 [project @ 1994-09-15 02:39:57 by jwe]
jwe
parents: 578
diff changeset
40 extern DECLARE_FUN (fname); \
21cc5b9b9ed6 [project @ 1994-09-15 02:39:57 by jwe]
jwe
parents: 578
diff changeset
41 DEFINE_FUN_STRUCT (name, fname, sname, nargin_max, nargout_max, \
21cc5b9b9ed6 [project @ 1994-09-15 02:39:57 by jwe]
jwe
parents: 578
diff changeset
42 is_text_fcn, doc); \
525
509e9a2d93a6 [project @ 1994-07-20 18:45:27 by jwe]
jwe
parents:
diff changeset
43 install_builtin_function (&sname); \
509e9a2d93a6 [project @ 1994-07-20 18:45:27 by jwe]
jwe
parents:
diff changeset
44 END_INSTALL_BUILTIN
509e9a2d93a6 [project @ 1994-07-20 18:45:27 by jwe]
jwe
parents:
diff changeset
45
550
95ee5e330179 [project @ 1994-07-22 20:17:58 by jwe]
jwe
parents: 540
diff changeset
46 // Generate code for making another name for an existing function.
95ee5e330179 [project @ 1994-07-22 20:17:58 by jwe]
jwe
parents: 540
diff changeset
47
95ee5e330179 [project @ 1994-07-22 20:17:58 by jwe]
jwe
parents: 540
diff changeset
48 #define DEFALIAS_INTERNAL(alias, name) \
95ee5e330179 [project @ 1994-07-22 20:17:58 by jwe]
jwe
parents: 540
diff changeset
49 BEGIN_INSTALL_BUILTIN \
95ee5e330179 [project @ 1994-07-22 20:17:58 by jwe]
jwe
parents: 540
diff changeset
50 alias_builtin (#alias, #name); \
95ee5e330179 [project @ 1994-07-22 20:17:58 by jwe]
jwe
parents: 540
diff changeset
51 END_INSTALL_BUILTIN
525
509e9a2d93a6 [project @ 1994-07-20 18:45:27 by jwe]
jwe
parents:
diff changeset
52
509e9a2d93a6 [project @ 1994-07-20 18:45:27 by jwe]
jwe
parents:
diff changeset
53 #else /* ! MAKE_BUILTINS */
509e9a2d93a6 [project @ 1994-07-20 18:45:27 by jwe]
jwe
parents:
diff changeset
54
550
95ee5e330179 [project @ 1994-07-22 20:17:58 by jwe]
jwe
parents: 540
diff changeset
55 // Generate the first line of the function definition. This ensures
95ee5e330179 [project @ 1994-07-22 20:17:58 by jwe]
jwe
parents: 540
diff changeset
56 // that the internal functions all have the same signature.
95ee5e330179 [project @ 1994-07-22 20:17:58 by jwe]
jwe
parents: 540
diff changeset
57
525
509e9a2d93a6 [project @ 1994-07-20 18:45:27 by jwe]
jwe
parents:
diff changeset
58 #define DEFUN_INTERNAL(name, fname, sname, nargin_max, nargout_max, \
509e9a2d93a6 [project @ 1994-07-20 18:45:27 by jwe]
jwe
parents:
diff changeset
59 is_text_fcn, doc) \
703
21cc5b9b9ed6 [project @ 1994-09-15 02:39:57 by jwe]
jwe
parents: 578
diff changeset
60 DECLARE_FUN (fname)
525
509e9a2d93a6 [project @ 1994-07-20 18:45:27 by jwe]
jwe
parents:
diff changeset
61
550
95ee5e330179 [project @ 1994-07-22 20:17:58 by jwe]
jwe
parents: 540
diff changeset
62 // No definition is required for an alias.
95ee5e330179 [project @ 1994-07-22 20:17:58 by jwe]
jwe
parents: 540
diff changeset
63
95ee5e330179 [project @ 1994-07-22 20:17:58 by jwe]
jwe
parents: 540
diff changeset
64 #define DEFALIAS_INTERNAL(name, alias)
525
509e9a2d93a6 [project @ 1994-07-20 18:45:27 by jwe]
jwe
parents:
diff changeset
65
509e9a2d93a6 [project @ 1994-07-20 18:45:27 by jwe]
jwe
parents:
diff changeset
66 #endif /* ! MAKE_BUILTINS */
509e9a2d93a6 [project @ 1994-07-20 18:45:27 by jwe]
jwe
parents:
diff changeset
67
703
21cc5b9b9ed6 [project @ 1994-09-15 02:39:57 by jwe]
jwe
parents: 578
diff changeset
68 // Define the structure that will be used to insert this function into
21cc5b9b9ed6 [project @ 1994-09-15 02:39:57 by jwe]
jwe
parents: 578
diff changeset
69 // the symbol table.
21cc5b9b9ed6 [project @ 1994-09-15 02:39:57 by jwe]
jwe
parents: 578
diff changeset
70
21cc5b9b9ed6 [project @ 1994-09-15 02:39:57 by jwe]
jwe
parents: 578
diff changeset
71 #define DEFINE_FUN_STRUCT(name, fname, sname, nargin_max, \
21cc5b9b9ed6 [project @ 1994-09-15 02:39:57 by jwe]
jwe
parents: 578
diff changeset
72 nargout_max, is_text_fcn, doc) \
21cc5b9b9ed6 [project @ 1994-09-15 02:39:57 by jwe]
jwe
parents: 578
diff changeset
73 static builtin_function sname = \
21cc5b9b9ed6 [project @ 1994-09-15 02:39:57 by jwe]
jwe
parents: 578
diff changeset
74 { name, nargin_max, nargout_max, is_text_fcn, fname, doc }
21cc5b9b9ed6 [project @ 1994-09-15 02:39:57 by jwe]
jwe
parents: 578
diff changeset
75
21cc5b9b9ed6 [project @ 1994-09-15 02:39:57 by jwe]
jwe
parents: 578
diff changeset
76 #define DEFINE_FUN_STRUCT_FUN(sname, fsname) \
21cc5b9b9ed6 [project @ 1994-09-15 02:39:57 by jwe]
jwe
parents: 578
diff changeset
77 builtin_function * \
21cc5b9b9ed6 [project @ 1994-09-15 02:39:57 by jwe]
jwe
parents: 578
diff changeset
78 fsname (void) \
21cc5b9b9ed6 [project @ 1994-09-15 02:39:57 by jwe]
jwe
parents: 578
diff changeset
79 { \
21cc5b9b9ed6 [project @ 1994-09-15 02:39:57 by jwe]
jwe
parents: 578
diff changeset
80 return &sname; \
21cc5b9b9ed6 [project @ 1994-09-15 02:39:57 by jwe]
jwe
parents: 578
diff changeset
81 }
21cc5b9b9ed6 [project @ 1994-09-15 02:39:57 by jwe]
jwe
parents: 578
diff changeset
82
550
95ee5e330179 [project @ 1994-07-22 20:17:58 by jwe]
jwe
parents: 540
diff changeset
83 // Declare an internal function named fname. This is the interface
95ee5e330179 [project @ 1994-07-22 20:17:58 by jwe]
jwe
parents: 540
diff changeset
84 // used by all internal functions in Octave that are also callable
95ee5e330179 [project @ 1994-07-22 20:17:58 by jwe]
jwe
parents: 540
diff changeset
85 // from the Octave language.
95ee5e330179 [project @ 1994-07-22 20:17:58 by jwe]
jwe
parents: 540
diff changeset
86
525
509e9a2d93a6 [project @ 1994-07-20 18:45:27 by jwe]
jwe
parents:
diff changeset
87 #define DECLARE_FUN(fname) \
509e9a2d93a6 [project @ 1994-07-20 18:45:27 by jwe]
jwe
parents:
diff changeset
88 Octave_object \
509e9a2d93a6 [project @ 1994-07-20 18:45:27 by jwe]
jwe
parents:
diff changeset
89 fname (const Octave_object& args, int nargout)
509e9a2d93a6 [project @ 1994-07-20 18:45:27 by jwe]
jwe
parents:
diff changeset
90
540
c07674bbc3b1 [project @ 1994-07-21 23:59:00 by jwe]
jwe
parents: 525
diff changeset
91 // XXX FIXME XXX -- eliminate the need for these in the functions that
c07674bbc3b1 [project @ 1994-07-21 23:59:00 by jwe]
jwe
parents: 525
diff changeset
92 // use them?
c07674bbc3b1 [project @ 1994-07-21 23:59:00 by jwe]
jwe
parents: 525
diff changeset
93
578
d169be9237fb [project @ 1994-08-03 20:06:54 by jwe]
jwe
parents: 550
diff changeset
94 #define DEFINE_ARGV(fcn_name) \
712
36ba0576bd1b [project @ 1994-09-19 14:18:15 by jwe]
jwe
parents: 703
diff changeset
95 int argc = args.length () + 1; \
540
c07674bbc3b1 [project @ 1994-07-21 23:59:00 by jwe]
jwe
parents: 525
diff changeset
96 int save_argc = argc; \
578
d169be9237fb [project @ 1994-08-03 20:06:54 by jwe]
jwe
parents: 550
diff changeset
97 char **argv = make_argv (args, fcn_name); \
540
c07674bbc3b1 [project @ 1994-07-21 23:59:00 by jwe]
jwe
parents: 525
diff changeset
98 char **save_argv = argv; \
525
509e9a2d93a6 [project @ 1994-07-20 18:45:27 by jwe]
jwe
parents:
diff changeset
99 if (error_state) \
509e9a2d93a6 [project @ 1994-07-20 18:45:27 by jwe]
jwe
parents:
diff changeset
100 return retval
509e9a2d93a6 [project @ 1994-07-20 18:45:27 by jwe]
jwe
parents:
diff changeset
101
509e9a2d93a6 [project @ 1994-07-20 18:45:27 by jwe]
jwe
parents:
diff changeset
102 #define DELETE_ARGV \
509e9a2d93a6 [project @ 1994-07-20 18:45:27 by jwe]
jwe
parents:
diff changeset
103 do \
509e9a2d93a6 [project @ 1994-07-20 18:45:27 by jwe]
jwe
parents:
diff changeset
104 { \
540
c07674bbc3b1 [project @ 1994-07-21 23:59:00 by jwe]
jwe
parents: 525
diff changeset
105 while (--save_argc >= 0) \
c07674bbc3b1 [project @ 1994-07-21 23:59:00 by jwe]
jwe
parents: 525
diff changeset
106 delete [] save_argv[save_argc]; \
c07674bbc3b1 [project @ 1994-07-21 23:59:00 by jwe]
jwe
parents: 525
diff changeset
107 delete [] save_argv; \
525
509e9a2d93a6 [project @ 1994-07-20 18:45:27 by jwe]
jwe
parents:
diff changeset
108 } \
509e9a2d93a6 [project @ 1994-07-20 18:45:27 by jwe]
jwe
parents:
diff changeset
109 while (0)
509e9a2d93a6 [project @ 1994-07-20 18:45:27 by jwe]
jwe
parents:
diff changeset
110
509e9a2d93a6 [project @ 1994-07-20 18:45:27 by jwe]
jwe
parents:
diff changeset
111 #endif
509e9a2d93a6 [project @ 1994-07-20 18:45:27 by jwe]
jwe
parents:
diff changeset
112
509e9a2d93a6 [project @ 1994-07-20 18:45:27 by jwe]
jwe
parents:
diff changeset
113 /*
509e9a2d93a6 [project @ 1994-07-20 18:45:27 by jwe]
jwe
parents:
diff changeset
114 ;;; Local Variables: ***
509e9a2d93a6 [project @ 1994-07-20 18:45:27 by jwe]
jwe
parents:
diff changeset
115 ;;; mode: C++ ***
509e9a2d93a6 [project @ 1994-07-20 18:45:27 by jwe]
jwe
parents:
diff changeset
116 ;;; page-delimiter: "^/\\*" ***
509e9a2d93a6 [project @ 1994-07-20 18:45:27 by jwe]
jwe
parents:
diff changeset
117 ;;; End: ***
509e9a2d93a6 [project @ 1994-07-20 18:45:27 by jwe]
jwe
parents:
diff changeset
118 */