annotate src/defun-int.h @ 1884:e62277bf5fe0

[project @ 1996-02-05 18:17:59 by jwe]
author jwe
date Mon, 05 Feb 1996 18:20:17 +0000
parents 3a9462b655f1
children 0e6a0a271998
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
1884
e62277bf5fe0 [project @ 1996-02-05 18:17:59 by jwe]
jwe
parents: 1755
diff changeset
4 Copyright (C) 1996 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
1315
611d403c7f3d [project @ 1995-06-25 19:56:32 by jwe]
jwe
parents: 1009
diff changeset
20 Software Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
525
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
1488
89c587478067 [project @ 1995-09-26 22:49:48 by jwe]
jwe
parents: 1315
diff changeset
37 #define DEFUN_INTERNAL(name, fname, sname, unused_arg_flags, \
525
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 \
1488
89c587478067 [project @ 1995-09-26 22:49:48 by jwe]
jwe
parents: 1315
diff changeset
40 extern DECLARE_FUN_ ## unused_arg_flags (fname); \
89c587478067 [project @ 1995-09-26 22:49:48 by jwe]
jwe
parents: 1315
diff changeset
41 DEFINE_FUN_STRUCT (name, fname, sname, is_text_fcn, doc); \
1755
3a9462b655f1 [project @ 1996-01-22 04:47:22 by jwe]
jwe
parents: 1488
diff changeset
42 install_builtin_function (sname); \
525
509e9a2d93a6 [project @ 1994-07-20 18:45:27 by jwe]
jwe
parents:
diff changeset
43 END_INSTALL_BUILTIN
509e9a2d93a6 [project @ 1994-07-20 18:45:27 by jwe]
jwe
parents:
diff changeset
44
550
95ee5e330179 [project @ 1994-07-22 20:17:58 by jwe]
jwe
parents: 540
diff changeset
45 // 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
46
95ee5e330179 [project @ 1994-07-22 20:17:58 by jwe]
jwe
parents: 540
diff changeset
47 #define DEFALIAS_INTERNAL(alias, name) \
95ee5e330179 [project @ 1994-07-22 20:17:58 by jwe]
jwe
parents: 540
diff changeset
48 BEGIN_INSTALL_BUILTIN \
95ee5e330179 [project @ 1994-07-22 20:17:58 by jwe]
jwe
parents: 540
diff changeset
49 alias_builtin (#alias, #name); \
95ee5e330179 [project @ 1994-07-22 20:17:58 by jwe]
jwe
parents: 540
diff changeset
50 END_INSTALL_BUILTIN
525
509e9a2d93a6 [project @ 1994-07-20 18:45:27 by jwe]
jwe
parents:
diff changeset
51
509e9a2d93a6 [project @ 1994-07-20 18:45:27 by jwe]
jwe
parents:
diff changeset
52 #else /* ! MAKE_BUILTINS */
509e9a2d93a6 [project @ 1994-07-20 18:45:27 by jwe]
jwe
parents:
diff changeset
53
550
95ee5e330179 [project @ 1994-07-22 20:17:58 by jwe]
jwe
parents: 540
diff changeset
54 // 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
55 // that the internal functions all have the same signature.
95ee5e330179 [project @ 1994-07-22 20:17:58 by jwe]
jwe
parents: 540
diff changeset
56
1488
89c587478067 [project @ 1995-09-26 22:49:48 by jwe]
jwe
parents: 1315
diff changeset
57 #define DEFUN_INTERNAL(name, fname, sname, unused_arg_flags, \
525
509e9a2d93a6 [project @ 1994-07-20 18:45:27 by jwe]
jwe
parents:
diff changeset
58 is_text_fcn, doc) \
1488
89c587478067 [project @ 1995-09-26 22:49:48 by jwe]
jwe
parents: 1315
diff changeset
59 DECLARE_FUN_ ## unused_arg_flags (fname)
525
509e9a2d93a6 [project @ 1994-07-20 18:45:27 by jwe]
jwe
parents:
diff changeset
60
550
95ee5e330179 [project @ 1994-07-22 20:17:58 by jwe]
jwe
parents: 540
diff changeset
61 // No definition is required for an alias.
95ee5e330179 [project @ 1994-07-22 20:17:58 by jwe]
jwe
parents: 540
diff changeset
62
95ee5e330179 [project @ 1994-07-22 20:17:58 by jwe]
jwe
parents: 540
diff changeset
63 #define DEFALIAS_INTERNAL(name, alias)
525
509e9a2d93a6 [project @ 1994-07-20 18:45:27 by jwe]
jwe
parents:
diff changeset
64
509e9a2d93a6 [project @ 1994-07-20 18:45:27 by jwe]
jwe
parents:
diff changeset
65 #endif /* ! MAKE_BUILTINS */
509e9a2d93a6 [project @ 1994-07-20 18:45:27 by jwe]
jwe
parents:
diff changeset
66
703
21cc5b9b9ed6 [project @ 1994-09-15 02:39:57 by jwe]
jwe
parents: 578
diff changeset
67 // 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
68 // the symbol table.
21cc5b9b9ed6 [project @ 1994-09-15 02:39:57 by jwe]
jwe
parents: 578
diff changeset
69
1488
89c587478067 [project @ 1995-09-26 22:49:48 by jwe]
jwe
parents: 1315
diff changeset
70 #define DEFINE_FUN_STRUCT(name, fname, sname, is_text_fcn, doc) \
1755
3a9462b655f1 [project @ 1996-01-22 04:47:22 by jwe]
jwe
parents: 1488
diff changeset
71 static builtin_function sname (name, is_text_fcn, fname, doc)
703
21cc5b9b9ed6 [project @ 1994-09-15 02:39:57 by jwe]
jwe
parents: 578
diff changeset
72
21cc5b9b9ed6 [project @ 1994-09-15 02:39:57 by jwe]
jwe
parents: 578
diff changeset
73 #define DEFINE_FUN_STRUCT_FUN(sname, fsname) \
1755
3a9462b655f1 [project @ 1996-01-22 04:47:22 by jwe]
jwe
parents: 1488
diff changeset
74 builtin_function& \
703
21cc5b9b9ed6 [project @ 1994-09-15 02:39:57 by jwe]
jwe
parents: 578
diff changeset
75 fsname (void) \
21cc5b9b9ed6 [project @ 1994-09-15 02:39:57 by jwe]
jwe
parents: 578
diff changeset
76 { \
1755
3a9462b655f1 [project @ 1996-01-22 04:47:22 by jwe]
jwe
parents: 1488
diff changeset
77 return sname; \
703
21cc5b9b9ed6 [project @ 1994-09-15 02:39:57 by jwe]
jwe
parents: 578
diff changeset
78 }
21cc5b9b9ed6 [project @ 1994-09-15 02:39:57 by jwe]
jwe
parents: 578
diff changeset
79
550
95ee5e330179 [project @ 1994-07-22 20:17:58 by jwe]
jwe
parents: 540
diff changeset
80 // 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
81 // used by all internal functions in Octave that are also callable
1488
89c587478067 [project @ 1995-09-26 22:49:48 by jwe]
jwe
parents: 1315
diff changeset
82 // from the Octave language. The funny suffixes are used to help us
89c587478067 [project @ 1995-09-26 22:49:48 by jwe]
jwe
parents: 1315
diff changeset
83 // avoid warnings from g++ about unused arguments.
89c587478067 [project @ 1995-09-26 22:49:48 by jwe]
jwe
parents: 1315
diff changeset
84
89c587478067 [project @ 1995-09-26 22:49:48 by jwe]
jwe
parents: 1315
diff changeset
85 #define DECLARE_FUN_00(fname) \
89c587478067 [project @ 1995-09-26 22:49:48 by jwe]
jwe
parents: 1315
diff changeset
86 Octave_object fname (const Octave_object&, int)
550
95ee5e330179 [project @ 1994-07-22 20:17:58 by jwe]
jwe
parents: 540
diff changeset
87
1488
89c587478067 [project @ 1995-09-26 22:49:48 by jwe]
jwe
parents: 1315
diff changeset
88 #define DECLARE_FUN_01(fname) \
89c587478067 [project @ 1995-09-26 22:49:48 by jwe]
jwe
parents: 1315
diff changeset
89 Octave_object fname (const Octave_object&, int nargout)
89c587478067 [project @ 1995-09-26 22:49:48 by jwe]
jwe
parents: 1315
diff changeset
90
89c587478067 [project @ 1995-09-26 22:49:48 by jwe]
jwe
parents: 1315
diff changeset
91 #define DECLARE_FUN_10(fname) \
89c587478067 [project @ 1995-09-26 22:49:48 by jwe]
jwe
parents: 1315
diff changeset
92 Octave_object fname (const Octave_object& args, int)
89c587478067 [project @ 1995-09-26 22:49:48 by jwe]
jwe
parents: 1315
diff changeset
93
89c587478067 [project @ 1995-09-26 22:49:48 by jwe]
jwe
parents: 1315
diff changeset
94 #define DECLARE_FUN_11(fname) \
89c587478067 [project @ 1995-09-26 22:49:48 by jwe]
jwe
parents: 1315
diff changeset
95 Octave_object fname (const Octave_object& args, int nargout)
89c587478067 [project @ 1995-09-26 22:49:48 by jwe]
jwe
parents: 1315
diff changeset
96
89c587478067 [project @ 1995-09-26 22:49:48 by jwe]
jwe
parents: 1315
diff changeset
97 #define DECLARE_FUN_(fname) DECLARE_FUN_11 (fname)
525
509e9a2d93a6 [project @ 1994-07-20 18:45:27 by jwe]
jwe
parents:
diff changeset
98
509e9a2d93a6 [project @ 1994-07-20 18:45:27 by jwe]
jwe
parents:
diff changeset
99 #endif
509e9a2d93a6 [project @ 1994-07-20 18:45:27 by jwe]
jwe
parents:
diff changeset
100
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 ;;; Local Variables: ***
509e9a2d93a6 [project @ 1994-07-20 18:45:27 by jwe]
jwe
parents:
diff changeset
103 ;;; mode: C++ ***
509e9a2d93a6 [project @ 1994-07-20 18:45:27 by jwe]
jwe
parents:
diff changeset
104 ;;; page-delimiter: "^/\\*" ***
509e9a2d93a6 [project @ 1994-07-20 18:45:27 by jwe]
jwe
parents:
diff changeset
105 ;;; End: ***
509e9a2d93a6 [project @ 1994-07-20 18:45:27 by jwe]
jwe
parents:
diff changeset
106 */