annotate src/defun-int.h @ 1957:0e6a0a271998

[project @ 1996-02-15 01:08:15 by jwe]
author jwe
date Thu, 15 Feb 1996 01:08:49 +0000
parents e62277bf5fe0
children 003570e69c7b
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
1957
0e6a0a271998 [project @ 1996-02-15 01:08:15 by jwe]
jwe
parents: 1884
diff changeset
37 #define DEFUN_INTERNAL(name, args_name, nargout_name, is_text_fcn, doc) \
525
509e9a2d93a6 [project @ 1994-07-20 18:45:27 by jwe]
jwe
parents:
diff changeset
38 BEGIN_INSTALL_BUILTIN \
1957
0e6a0a271998 [project @ 1996-02-15 01:08:15 by jwe]
jwe
parents: 1884
diff changeset
39 extern DECLARE_FUN (name, args_name, nargout_name); \
0e6a0a271998 [project @ 1996-02-15 01:08:15 by jwe]
jwe
parents: 1884
diff changeset
40 DEFINE_FUN_STRUCT (name, is_text_fcn, doc); \
0e6a0a271998 [project @ 1996-02-15 01:08:15 by jwe]
jwe
parents: 1884
diff changeset
41 install_builtin_function (S ## name); \
525
509e9a2d93a6 [project @ 1994-07-20 18:45:27 by jwe]
jwe
parents:
diff changeset
42 END_INSTALL_BUILTIN
509e9a2d93a6 [project @ 1994-07-20 18:45:27 by jwe]
jwe
parents:
diff changeset
43
550
95ee5e330179 [project @ 1994-07-22 20:17:58 by jwe]
jwe
parents: 540
diff changeset
44 // 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
45
95ee5e330179 [project @ 1994-07-22 20:17:58 by jwe]
jwe
parents: 540
diff changeset
46 #define DEFALIAS_INTERNAL(alias, name) \
95ee5e330179 [project @ 1994-07-22 20:17:58 by jwe]
jwe
parents: 540
diff changeset
47 BEGIN_INSTALL_BUILTIN \
95ee5e330179 [project @ 1994-07-22 20:17:58 by jwe]
jwe
parents: 540
diff changeset
48 alias_builtin (#alias, #name); \
95ee5e330179 [project @ 1994-07-22 20:17:58 by jwe]
jwe
parents: 540
diff changeset
49 END_INSTALL_BUILTIN
525
509e9a2d93a6 [project @ 1994-07-20 18:45:27 by jwe]
jwe
parents:
diff changeset
50
509e9a2d93a6 [project @ 1994-07-20 18:45:27 by jwe]
jwe
parents:
diff changeset
51 #else /* ! MAKE_BUILTINS */
509e9a2d93a6 [project @ 1994-07-20 18:45:27 by jwe]
jwe
parents:
diff changeset
52
550
95ee5e330179 [project @ 1994-07-22 20:17:58 by jwe]
jwe
parents: 540
diff changeset
53 // 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
54 // that the internal functions all have the same signature.
95ee5e330179 [project @ 1994-07-22 20:17:58 by jwe]
jwe
parents: 540
diff changeset
55
1957
0e6a0a271998 [project @ 1996-02-15 01:08:15 by jwe]
jwe
parents: 1884
diff changeset
56 #define DEFUN_INTERNAL(name, args_name, nargout_name, is_text_fcn, doc) \
0e6a0a271998 [project @ 1996-02-15 01:08:15 by jwe]
jwe
parents: 1884
diff changeset
57 DECLARE_FUN (name, args_name, nargout_name)
525
509e9a2d93a6 [project @ 1994-07-20 18:45:27 by jwe]
jwe
parents:
diff changeset
58
550
95ee5e330179 [project @ 1994-07-22 20:17:58 by jwe]
jwe
parents: 540
diff changeset
59 // No definition is required for an alias.
95ee5e330179 [project @ 1994-07-22 20:17:58 by jwe]
jwe
parents: 540
diff changeset
60
95ee5e330179 [project @ 1994-07-22 20:17:58 by jwe]
jwe
parents: 540
diff changeset
61 #define DEFALIAS_INTERNAL(name, alias)
525
509e9a2d93a6 [project @ 1994-07-20 18:45:27 by jwe]
jwe
parents:
diff changeset
62
509e9a2d93a6 [project @ 1994-07-20 18:45:27 by jwe]
jwe
parents:
diff changeset
63 #endif /* ! MAKE_BUILTINS */
509e9a2d93a6 [project @ 1994-07-20 18:45:27 by jwe]
jwe
parents:
diff changeset
64
703
21cc5b9b9ed6 [project @ 1994-09-15 02:39:57 by jwe]
jwe
parents: 578
diff changeset
65 // 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
66 // the symbol table.
21cc5b9b9ed6 [project @ 1994-09-15 02:39:57 by jwe]
jwe
parents: 578
diff changeset
67
1957
0e6a0a271998 [project @ 1996-02-15 01:08:15 by jwe]
jwe
parents: 1884
diff changeset
68 #define DEFINE_FUN_STRUCT(name, is_text_fcn, doc) \
0e6a0a271998 [project @ 1996-02-15 01:08:15 by jwe]
jwe
parents: 1884
diff changeset
69 static builtin_function S ## name (#name, is_text_fcn, F ## name, doc)
703
21cc5b9b9ed6 [project @ 1994-09-15 02:39:57 by jwe]
jwe
parents: 578
diff changeset
70
1957
0e6a0a271998 [project @ 1996-02-15 01:08:15 by jwe]
jwe
parents: 1884
diff changeset
71 #define DEFINE_FUN_STRUCT_FUN(name) \
1755
3a9462b655f1 [project @ 1996-01-22 04:47:22 by jwe]
jwe
parents: 1488
diff changeset
72 builtin_function& \
1957
0e6a0a271998 [project @ 1996-02-15 01:08:15 by jwe]
jwe
parents: 1884
diff changeset
73 FS ## name (void) \
703
21cc5b9b9ed6 [project @ 1994-09-15 02:39:57 by jwe]
jwe
parents: 578
diff changeset
74 { \
1957
0e6a0a271998 [project @ 1996-02-15 01:08:15 by jwe]
jwe
parents: 1884
diff changeset
75 return S ## name; \
703
21cc5b9b9ed6 [project @ 1994-09-15 02:39:57 by jwe]
jwe
parents: 578
diff changeset
76 }
21cc5b9b9ed6 [project @ 1994-09-15 02:39:57 by jwe]
jwe
parents: 578
diff changeset
77
1957
0e6a0a271998 [project @ 1996-02-15 01:08:15 by jwe]
jwe
parents: 1884
diff changeset
78 #define DECLARE_FUN(name, args_name, nargout_name) \
0e6a0a271998 [project @ 1996-02-15 01:08:15 by jwe]
jwe
parents: 1884
diff changeset
79 Octave_object F ## name (const Octave_object& args_name, int nargout_name)
525
509e9a2d93a6 [project @ 1994-07-20 18:45:27 by jwe]
jwe
parents:
diff changeset
80
509e9a2d93a6 [project @ 1994-07-20 18:45:27 by jwe]
jwe
parents:
diff changeset
81 #endif
509e9a2d93a6 [project @ 1994-07-20 18:45:27 by jwe]
jwe
parents:
diff changeset
82
509e9a2d93a6 [project @ 1994-07-20 18:45:27 by jwe]
jwe
parents:
diff changeset
83 /*
509e9a2d93a6 [project @ 1994-07-20 18:45:27 by jwe]
jwe
parents:
diff changeset
84 ;;; Local Variables: ***
509e9a2d93a6 [project @ 1994-07-20 18:45:27 by jwe]
jwe
parents:
diff changeset
85 ;;; mode: C++ ***
509e9a2d93a6 [project @ 1994-07-20 18:45:27 by jwe]
jwe
parents:
diff changeset
86 ;;; page-delimiter: "^/\\*" ***
509e9a2d93a6 [project @ 1994-07-20 18:45:27 by jwe]
jwe
parents:
diff changeset
87 ;;; End: ***
509e9a2d93a6 [project @ 1994-07-20 18:45:27 by jwe]
jwe
parents:
diff changeset
88 */