annotate libinterp/parse-tree/pt-misc.h @ 17744:d63878346099

maint: Update copyright notices for release.
author John W. Eaton <jwe@octave.org>
date Wed, 23 Oct 2013 22:09:27 -0400
parents 8e2906e2fb26
children 175b392e91fe
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
577
91e2164fb1b2 [project @ 1994-08-03 20:06:54 by jwe]
jwe
parents:
diff changeset
1 /*
91e2164fb1b2 [project @ 1994-08-03 20:06:54 by jwe]
jwe
parents:
diff changeset
2
17744
d63878346099 maint: Update copyright notices for release.
John W. Eaton <jwe@octave.org>
parents: 17316
diff changeset
3 Copyright (C) 1994-2013 John W. Eaton
577
91e2164fb1b2 [project @ 1994-08-03 20:06:54 by jwe]
jwe
parents:
diff changeset
4
91e2164fb1b2 [project @ 1994-08-03 20:06:54 by jwe]
jwe
parents:
diff changeset
5 This file is part of Octave.
91e2164fb1b2 [project @ 1994-08-03 20:06:54 by jwe]
jwe
parents:
diff changeset
6
91e2164fb1b2 [project @ 1994-08-03 20:06:54 by jwe]
jwe
parents:
diff changeset
7 Octave is free software; you can redistribute it and/or modify it
91e2164fb1b2 [project @ 1994-08-03 20:06:54 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: 6215
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: 6215
diff changeset
10 option) any later version.
577
91e2164fb1b2 [project @ 1994-08-03 20:06:54 by jwe]
jwe
parents:
diff changeset
11
91e2164fb1b2 [project @ 1994-08-03 20:06:54 by jwe]
jwe
parents:
diff changeset
12 Octave is distributed in the hope that it will be useful, but WITHOUT
91e2164fb1b2 [project @ 1994-08-03 20:06:54 by jwe]
jwe
parents:
diff changeset
13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
91e2164fb1b2 [project @ 1994-08-03 20:06:54 by jwe]
jwe
parents:
diff changeset
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
91e2164fb1b2 [project @ 1994-08-03 20:06:54 by jwe]
jwe
parents:
diff changeset
15 for more details.
91e2164fb1b2 [project @ 1994-08-03 20:06:54 by jwe]
jwe
parents:
diff changeset
16
91e2164fb1b2 [project @ 1994-08-03 20:06:54 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: 6215
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: 6215
diff changeset
19 <http://www.gnu.org/licenses/>.
577
91e2164fb1b2 [project @ 1994-08-03 20:06:54 by jwe]
jwe
parents:
diff changeset
20
91e2164fb1b2 [project @ 1994-08-03 20:06:54 by jwe]
jwe
parents:
diff changeset
21 */
91e2164fb1b2 [project @ 1994-08-03 20:06:54 by jwe]
jwe
parents:
diff changeset
22
91e2164fb1b2 [project @ 1994-08-03 20:06:54 by jwe]
jwe
parents:
diff changeset
23 #if !defined (octave_tree_misc_h)
91e2164fb1b2 [project @ 1994-08-03 20:06:54 by jwe]
jwe
parents:
diff changeset
24 #define octave_tree_misc_h 1
91e2164fb1b2 [project @ 1994-08-03 20:06:54 by jwe]
jwe
parents:
diff changeset
25
5848
415ae81d331b [project @ 2006-06-08 20:37:29 by jwe]
jwe
parents: 5307
diff changeset
26 class Cell;
415ae81d331b [project @ 2006-06-08 20:37:29 by jwe]
jwe
parents: 5307
diff changeset
27
2982
20f5cec4f11c [project @ 1997-05-16 03:29:26 by jwe]
jwe
parents: 2973
diff changeset
28 class octave_value;
20f5cec4f11c [project @ 1997-05-16 03:29:26 by jwe]
jwe
parents: 2973
diff changeset
29 class octave_value_list;
577
91e2164fb1b2 [project @ 1994-08-03 20:06:54 by jwe]
jwe
parents:
diff changeset
30
2982
20f5cec4f11c [project @ 1997-05-16 03:29:26 by jwe]
jwe
parents: 2973
diff changeset
31 class tree_identifier;
20f5cec4f11c [project @ 1997-05-16 03:29:26 by jwe]
jwe
parents: 2973
diff changeset
32 class tree_index_expression;
20f5cec4f11c [project @ 1997-05-16 03:29:26 by jwe]
jwe
parents: 2973
diff changeset
33 class tree_va_return_list;
1588
27f5ac98fc4a [project @ 1995-10-31 06:04:47 by jwe]
jwe
parents: 1510
diff changeset
34
2982
20f5cec4f11c [project @ 1997-05-16 03:29:26 by jwe]
jwe
parents: 2973
diff changeset
35 class tree_walker;
577
91e2164fb1b2 [project @ 1994-08-03 20:06:54 by jwe]
jwe
parents:
diff changeset
36
4219
23d06c9e1edd [project @ 2002-12-06 21:29:17 by jwe]
jwe
parents: 4212
diff changeset
37 #include "base-list.h"
6215
516d3071b34c [project @ 2006-12-15 03:24:12 by jwe]
jwe
parents: 5861
diff changeset
38 #include "pt-decl.h"
7336
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7017
diff changeset
39 #include "symtab.h"
4219
23d06c9e1edd [project @ 2002-12-06 21:29:17 by jwe]
jwe
parents: 4212
diff changeset
40
577
91e2164fb1b2 [project @ 1994-08-03 20:06:54 by jwe]
jwe
parents:
diff changeset
41 // Parameter lists. Used to hold the list of input and output
91e2164fb1b2 [project @ 1994-08-03 20:06:54 by jwe]
jwe
parents:
diff changeset
42 // parameters in a function definition. Elements are identifiers
91e2164fb1b2 [project @ 1994-08-03 20:06:54 by jwe]
jwe
parents:
diff changeset
43 // only.
91e2164fb1b2 [project @ 1994-08-03 20:06:54 by jwe]
jwe
parents:
diff changeset
44
91e2164fb1b2 [project @ 1994-08-03 20:06:54 by jwe]
jwe
parents:
diff changeset
45 class
6215
516d3071b34c [project @ 2006-12-15 03:24:12 by jwe]
jwe
parents: 5861
diff changeset
46 tree_parameter_list : public octave_base_list<tree_decl_elt *>
577
91e2164fb1b2 [project @ 1994-08-03 20:06:54 by jwe]
jwe
parents:
diff changeset
47 {
91e2164fb1b2 [project @ 1994-08-03 20:06:54 by jwe]
jwe
parents:
diff changeset
48 public:
2124
97a566037a75 [project @ 1996-05-12 07:16:36 by jwe]
jwe
parents: 2086
diff changeset
49
7587
1f662945c2be handle varargin and varargout without keywords
John W. Eaton <jwe@octave.org>
parents: 7336
diff changeset
50 enum in_or_out
1f662945c2be handle varargin and varargout without keywords
John W. Eaton <jwe@octave.org>
parents: 7336
diff changeset
51 {
1f662945c2be handle varargin and varargout without keywords
John W. Eaton <jwe@octave.org>
parents: 7336
diff changeset
52 in = 1,
1f662945c2be handle varargin and varargout without keywords
John W. Eaton <jwe@octave.org>
parents: 7336
diff changeset
53 out = 2
1f662945c2be handle varargin and varargout without keywords
John W. Eaton <jwe@octave.org>
parents: 7336
diff changeset
54 };
1f662945c2be handle varargin and varargout without keywords
John W. Eaton <jwe@octave.org>
parents: 7336
diff changeset
55
1227
766e2a1a4e7b [project @ 1995-04-10 00:48:19 by jwe]
jwe
parents: 1127
diff changeset
56 tree_parameter_list (void)
4219
23d06c9e1edd [project @ 2002-12-06 21:29:17 by jwe]
jwe
parents: 4212
diff changeset
57 : marked_for_varargs (0) { }
632
ddc21c0f0089 [project @ 1994-08-19 22:20:16 by jwe]
jwe
parents: 581
diff changeset
58
6215
516d3071b34c [project @ 2006-12-15 03:24:12 by jwe]
jwe
parents: 5861
diff changeset
59 tree_parameter_list (tree_decl_elt *t)
4219
23d06c9e1edd [project @ 2002-12-06 21:29:17 by jwe]
jwe
parents: 4212
diff changeset
60 : marked_for_varargs (0) { append (t); }
577
91e2164fb1b2 [project @ 1994-08-03 20:06:54 by jwe]
jwe
parents:
diff changeset
61
17316
8e2906e2fb26 avoid reduce/reduce conflict in parser rules
John W. Eaton <jwe@octave.org>
parents: 16360
diff changeset
62 tree_parameter_list (tree_identifier *id)
8e2906e2fb26 avoid reduce/reduce conflict in parser rules
John W. Eaton <jwe@octave.org>
parents: 16360
diff changeset
63 : marked_for_varargs (0) { append (new tree_decl_elt (id)); }
8e2906e2fb26 avoid reduce/reduce conflict in parser rules
John W. Eaton <jwe@octave.org>
parents: 16360
diff changeset
64
1740
fe9d3b2ded26 [project @ 1996-01-12 11:03:26 by jwe]
jwe
parents: 1588
diff changeset
65 ~tree_parameter_list (void);
577
91e2164fb1b2 [project @ 1994-08-03 20:06:54 by jwe]
jwe
parents:
diff changeset
66
91e2164fb1b2 [project @ 1994-08-03 20:06:54 by jwe]
jwe
parents:
diff changeset
67 void mark_as_formal_parameters (void);
91e2164fb1b2 [project @ 1994-08-03 20:06:54 by jwe]
jwe
parents:
diff changeset
68
7587
1f662945c2be handle varargin and varargout without keywords
John W. Eaton <jwe@octave.org>
parents: 7336
diff changeset
69 bool validate (in_or_out type);
577
91e2164fb1b2 [project @ 1994-08-03 20:06:54 by jwe]
jwe
parents:
diff changeset
70
3933
f9ea3dcf58ee [project @ 2002-05-15 03:21:00 by jwe]
jwe
parents: 3239
diff changeset
71 bool takes_varargs (void) const { return marked_for_varargs != 0; }
577
91e2164fb1b2 [project @ 1994-08-03 20:06:54 by jwe]
jwe
parents:
diff changeset
72
3933
f9ea3dcf58ee [project @ 2002-05-15 03:21:00 by jwe]
jwe
parents: 3239
diff changeset
73 bool varargs_only (void) { return (marked_for_varargs < 0); }
577
91e2164fb1b2 [project @ 1994-08-03 20:06:54 by jwe]
jwe
parents:
diff changeset
74
4466
b18007283045 [project @ 2003-07-15 11:43:28 by jwe]
jwe
parents: 4261
diff changeset
75 void initialize_undefined_elements (const std::string& warnfor,
10313
f3b65e1ae355 untabify src header files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
76 int nargout, const octave_value& val);
1093
51fd9e40a7f7 [project @ 1995-02-03 21:57:34 by jwe]
jwe
parents: 1063
diff changeset
77
2086
bfb775fb6fe8 [project @ 1996-04-25 05:55:19 by jwe]
jwe
parents: 1996
diff changeset
78 void define_from_arg_vector (const octave_value_list& args);
577
91e2164fb1b2 [project @ 1994-08-03 20:06:54 by jwe]
jwe
parents:
diff changeset
79
4219
23d06c9e1edd [project @ 2002-12-06 21:29:17 by jwe]
jwe
parents: 4212
diff changeset
80 void undefine (void);
3239
d54ef0aa6e82 [project @ 1999-03-27 17:40:45 by jwe]
jwe
parents: 2988
diff changeset
81
1827
effa9400766f [project @ 1996-02-02 14:07:51 by jwe]
jwe
parents: 1740
diff changeset
82 bool is_defined (void);
577
91e2164fb1b2 [project @ 1994-08-03 20:06:54 by jwe]
jwe
parents:
diff changeset
83
16360
11115c237231 recognize variables when parsing (bug #38576)
John W. Eaton <jwe@octave.org>
parents: 15195
diff changeset
84 std::list<std::string> variable_names (void) const;
11115c237231 recognize variables when parsing (bug #38576)
John W. Eaton <jwe@octave.org>
parents: 15195
diff changeset
85
9644
080e11f1b0c1 don't return undefined output values from user functions
Jaroslav Hajek <highegg@gmail.com>
parents: 8920
diff changeset
86 octave_value_list convert_to_const_vector (int nargout, const Cell& varargout);
577
91e2164fb1b2 [project @ 1994-08-03 20:06:54 by jwe]
jwe
parents:
diff changeset
87
7767
71f068b22fcc scope and context fixes for function handles
John W. Eaton <jwe@octave.org>
parents: 7587
diff changeset
88 tree_parameter_list *dup (symbol_table::scope_id scope,
10313
f3b65e1ae355 untabify src header files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
89 symbol_table::context_id context) const;
5861
2a6cb4ed8f1e [project @ 2006-06-16 05:09:41 by jwe]
jwe
parents: 5848
diff changeset
90
2124
97a566037a75 [project @ 1996-05-12 07:16:36 by jwe]
jwe
parents: 2086
diff changeset
91 void accept (tree_walker& tw);
581
bc813f5eb025 [project @ 1994-08-07 01:02:15 by jwe]
jwe
parents: 577
diff changeset
92
577
91e2164fb1b2 [project @ 1994-08-03 20:06:54 by jwe]
jwe
parents:
diff changeset
93 private:
2124
97a566037a75 [project @ 1996-05-12 07:16:36 by jwe]
jwe
parents: 2086
diff changeset
94
577
91e2164fb1b2 [project @ 1994-08-03 20:06:54 by jwe]
jwe
parents:
diff changeset
95 int marked_for_varargs;
2988
daa1ed1f5462 [project @ 1997-05-16 07:23:15 by jwe]
jwe
parents: 2982
diff changeset
96
7587
1f662945c2be handle varargin and varargout without keywords
John W. Eaton <jwe@octave.org>
parents: 7336
diff changeset
97 void mark_varargs (void) { marked_for_varargs = 1; }
1f662945c2be handle varargin and varargout without keywords
John W. Eaton <jwe@octave.org>
parents: 7336
diff changeset
98
1f662945c2be handle varargin and varargout without keywords
John W. Eaton <jwe@octave.org>
parents: 7336
diff changeset
99 void mark_varargs_only (void) { marked_for_varargs = -1; }
1f662945c2be handle varargin and varargout without keywords
John W. Eaton <jwe@octave.org>
parents: 7336
diff changeset
100
2988
daa1ed1f5462 [project @ 1997-05-16 07:23:15 by jwe]
jwe
parents: 2982
diff changeset
101 // No copying!
daa1ed1f5462 [project @ 1997-05-16 07:23:15 by jwe]
jwe
parents: 2982
diff changeset
102
daa1ed1f5462 [project @ 1997-05-16 07:23:15 by jwe]
jwe
parents: 2982
diff changeset
103 tree_parameter_list (const tree_parameter_list&);
daa1ed1f5462 [project @ 1997-05-16 07:23:15 by jwe]
jwe
parents: 2982
diff changeset
104
daa1ed1f5462 [project @ 1997-05-16 07:23:15 by jwe]
jwe
parents: 2982
diff changeset
105 tree_parameter_list& operator = (const tree_parameter_list&);
577
91e2164fb1b2 [project @ 1994-08-03 20:06:54 by jwe]
jwe
parents:
diff changeset
106 };
91e2164fb1b2 [project @ 1994-08-03 20:06:54 by jwe]
jwe
parents:
diff changeset
107
91e2164fb1b2 [project @ 1994-08-03 20:06:54 by jwe]
jwe
parents:
diff changeset
108 // Return lists. Used to hold the right hand sides of multiple
91e2164fb1b2 [project @ 1994-08-03 20:06:54 by jwe]
jwe
parents:
diff changeset
109 // assignment expressions.
91e2164fb1b2 [project @ 1994-08-03 20:06:54 by jwe]
jwe
parents:
diff changeset
110
91e2164fb1b2 [project @ 1994-08-03 20:06:54 by jwe]
jwe
parents:
diff changeset
111 class
4219
23d06c9e1edd [project @ 2002-12-06 21:29:17 by jwe]
jwe
parents: 4212
diff changeset
112 tree_return_list : public octave_base_list<tree_index_expression *>
577
91e2164fb1b2 [project @ 1994-08-03 20:06:54 by jwe]
jwe
parents:
diff changeset
113 {
91e2164fb1b2 [project @ 1994-08-03 20:06:54 by jwe]
jwe
parents:
diff changeset
114 public:
2124
97a566037a75 [project @ 1996-05-12 07:16:36 by jwe]
jwe
parents: 2086
diff changeset
115
4219
23d06c9e1edd [project @ 2002-12-06 21:29:17 by jwe]
jwe
parents: 4212
diff changeset
116 tree_return_list (void) { }
1227
766e2a1a4e7b [project @ 1995-04-10 00:48:19 by jwe]
jwe
parents: 1127
diff changeset
117
4219
23d06c9e1edd [project @ 2002-12-06 21:29:17 by jwe]
jwe
parents: 4212
diff changeset
118 tree_return_list (tree_index_expression *t) { append (t); }
577
91e2164fb1b2 [project @ 1994-08-03 20:06:54 by jwe]
jwe
parents:
diff changeset
119
1740
fe9d3b2ded26 [project @ 1996-01-12 11:03:26 by jwe]
jwe
parents: 1588
diff changeset
120 ~tree_return_list (void);
581
bc813f5eb025 [project @ 1994-08-07 01:02:15 by jwe]
jwe
parents: 577
diff changeset
121
7767
71f068b22fcc scope and context fixes for function handles
John W. Eaton <jwe@octave.org>
parents: 7587
diff changeset
122 tree_return_list *dup (symbol_table::scope_id scope,
10313
f3b65e1ae355 untabify src header files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
123 symbol_table::context_id context) const;
5861
2a6cb4ed8f1e [project @ 2006-06-16 05:09:41 by jwe]
jwe
parents: 5848
diff changeset
124
2124
97a566037a75 [project @ 1996-05-12 07:16:36 by jwe]
jwe
parents: 2086
diff changeset
125 void accept (tree_walker& tw);
2988
daa1ed1f5462 [project @ 1997-05-16 07:23:15 by jwe]
jwe
parents: 2982
diff changeset
126
daa1ed1f5462 [project @ 1997-05-16 07:23:15 by jwe]
jwe
parents: 2982
diff changeset
127 private:
daa1ed1f5462 [project @ 1997-05-16 07:23:15 by jwe]
jwe
parents: 2982
diff changeset
128
daa1ed1f5462 [project @ 1997-05-16 07:23:15 by jwe]
jwe
parents: 2982
diff changeset
129 // No copying!
daa1ed1f5462 [project @ 1997-05-16 07:23:15 by jwe]
jwe
parents: 2982
diff changeset
130
daa1ed1f5462 [project @ 1997-05-16 07:23:15 by jwe]
jwe
parents: 2982
diff changeset
131 tree_return_list (const tree_return_list&);
daa1ed1f5462 [project @ 1997-05-16 07:23:15 by jwe]
jwe
parents: 2982
diff changeset
132
daa1ed1f5462 [project @ 1997-05-16 07:23:15 by jwe]
jwe
parents: 2982
diff changeset
133 tree_return_list& operator = (const tree_return_list&);
577
91e2164fb1b2 [project @ 1994-08-03 20:06:54 by jwe]
jwe
parents:
diff changeset
134 };
91e2164fb1b2 [project @ 1994-08-03 20:06:54 by jwe]
jwe
parents:
diff changeset
135
723
1c072f20b522 [project @ 1994-09-21 16:00:10 by jwe]
jwe
parents: 672
diff changeset
136 class
4219
23d06c9e1edd [project @ 2002-12-06 21:29:17 by jwe]
jwe
parents: 4212
diff changeset
137 tree_va_return_list : public octave_base_list<octave_value>
723
1c072f20b522 [project @ 1994-09-21 16:00:10 by jwe]
jwe
parents: 672
diff changeset
138 {
1c072f20b522 [project @ 1994-09-21 16:00:10 by jwe]
jwe
parents: 672
diff changeset
139 public:
2124
97a566037a75 [project @ 1996-05-12 07:16:36 by jwe]
jwe
parents: 2086
diff changeset
140
4219
23d06c9e1edd [project @ 2002-12-06 21:29:17 by jwe]
jwe
parents: 4212
diff changeset
141 tree_va_return_list (void) { }
1269
abaf21f34109 [project @ 1995-04-20 19:16:24 by jwe]
jwe
parents: 1227
diff changeset
142
abaf21f34109 [project @ 1995-04-20 19:16:24 by jwe]
jwe
parents: 1227
diff changeset
143 ~tree_va_return_list (void) { }
2988
daa1ed1f5462 [project @ 1997-05-16 07:23:15 by jwe]
jwe
parents: 2982
diff changeset
144
daa1ed1f5462 [project @ 1997-05-16 07:23:15 by jwe]
jwe
parents: 2982
diff changeset
145 private:
daa1ed1f5462 [project @ 1997-05-16 07:23:15 by jwe]
jwe
parents: 2982
diff changeset
146
daa1ed1f5462 [project @ 1997-05-16 07:23:15 by jwe]
jwe
parents: 2982
diff changeset
147 // No copying!
daa1ed1f5462 [project @ 1997-05-16 07:23:15 by jwe]
jwe
parents: 2982
diff changeset
148
daa1ed1f5462 [project @ 1997-05-16 07:23:15 by jwe]
jwe
parents: 2982
diff changeset
149 tree_va_return_list (const tree_va_return_list&);
daa1ed1f5462 [project @ 1997-05-16 07:23:15 by jwe]
jwe
parents: 2982
diff changeset
150
daa1ed1f5462 [project @ 1997-05-16 07:23:15 by jwe]
jwe
parents: 2982
diff changeset
151 tree_va_return_list& operator = (const tree_va_return_list&);
723
1c072f20b522 [project @ 1994-09-21 16:00:10 by jwe]
jwe
parents: 672
diff changeset
152 };
1c072f20b522 [project @ 1994-09-21 16:00:10 by jwe]
jwe
parents: 672
diff changeset
153
577
91e2164fb1b2 [project @ 1994-08-03 20:06:54 by jwe]
jwe
parents:
diff changeset
154 #endif