annotate src/pt-exp.h @ 14138:72c96de7a403 stable

maint: update copyright notices for 2012
author John W. Eaton <jwe@octave.org>
date Mon, 02 Jan 2012 14:25:41 -0500
parents fd0a3ac60b0e
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1739
bbfca89cb1cd [project @ 1996-01-12 11:03:26 by jwe]
jwe
parents:
diff changeset
1 /*
bbfca89cb1cd [project @ 1996-01-12 11:03:26 by jwe]
jwe
parents:
diff changeset
2
14138
72c96de7a403 maint: update copyright notices for 2012
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
3 Copyright (C) 1996-2012 John W. Eaton
1739
bbfca89cb1cd [project @ 1996-01-12 11:03:26 by jwe]
jwe
parents:
diff changeset
4
bbfca89cb1cd [project @ 1996-01-12 11:03:26 by jwe]
jwe
parents:
diff changeset
5 This file is part of Octave.
bbfca89cb1cd [project @ 1996-01-12 11:03:26 by jwe]
jwe
parents:
diff changeset
6
bbfca89cb1cd [project @ 1996-01-12 11:03:26 by jwe]
jwe
parents:
diff changeset
7 Octave is free software; you can redistribute it and/or modify it
bbfca89cb1cd [project @ 1996-01-12 11:03:26 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: 5861
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: 5861
diff changeset
10 option) any later version.
1739
bbfca89cb1cd [project @ 1996-01-12 11:03:26 by jwe]
jwe
parents:
diff changeset
11
bbfca89cb1cd [project @ 1996-01-12 11:03:26 by jwe]
jwe
parents:
diff changeset
12 Octave is distributed in the hope that it will be useful, but WITHOUT
bbfca89cb1cd [project @ 1996-01-12 11:03:26 by jwe]
jwe
parents:
diff changeset
13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
bbfca89cb1cd [project @ 1996-01-12 11:03:26 by jwe]
jwe
parents:
diff changeset
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
bbfca89cb1cd [project @ 1996-01-12 11:03:26 by jwe]
jwe
parents:
diff changeset
15 for more details.
bbfca89cb1cd [project @ 1996-01-12 11:03:26 by jwe]
jwe
parents:
diff changeset
16
bbfca89cb1cd [project @ 1996-01-12 11:03:26 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: 5861
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: 5861
diff changeset
19 <http://www.gnu.org/licenses/>.
1739
bbfca89cb1cd [project @ 1996-01-12 11:03:26 by jwe]
jwe
parents:
diff changeset
20
bbfca89cb1cd [project @ 1996-01-12 11:03:26 by jwe]
jwe
parents:
diff changeset
21 */
bbfca89cb1cd [project @ 1996-01-12 11:03:26 by jwe]
jwe
parents:
diff changeset
22
2980
cd5ad3fd8049 [project @ 1997-05-16 01:12:13 by jwe]
jwe
parents: 2979
diff changeset
23 #if !defined (octave_tree_expr_h)
cd5ad3fd8049 [project @ 1997-05-16 01:12:13 by jwe]
jwe
parents: 2979
diff changeset
24 #define octave_tree_expr_h 1
1739
bbfca89cb1cd [project @ 1996-01-12 11:03:26 by jwe]
jwe
parents:
diff changeset
25
2980
cd5ad3fd8049 [project @ 1997-05-16 01:12:13 by jwe]
jwe
parents: 2979
diff changeset
26 #include <string>
10832
1b2fcd122c6a allow user detect ignored outputs in m-functions
Jaroslav Hajek <highegg@gmail.com>
parents: 10313
diff changeset
27 #include <list>
2124
97a566037a75 [project @ 1996-05-12 07:16:36 by jwe]
jwe
parents: 2086
diff changeset
28
2879
4309724baab6 [project @ 1997-04-24 09:30:23 by jwe]
jwe
parents: 2859
diff changeset
29 class octave_value;
2979
a3556d2adec9 [project @ 1997-05-15 22:35:37 by jwe]
jwe
parents: 2971
diff changeset
30 class octave_lvalue;
2879
4309724baab6 [project @ 1997-04-24 09:30:23 by jwe]
jwe
parents: 2859
diff changeset
31
2988
daa1ed1f5462 [project @ 1997-05-16 07:23:15 by jwe]
jwe
parents: 2980
diff changeset
32 #include "pt.h"
7336
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7017
diff changeset
33 #include "symtab.h"
2124
97a566037a75 [project @ 1996-05-12 07:16:36 by jwe]
jwe
parents: 2086
diff changeset
34
2980
cd5ad3fd8049 [project @ 1997-05-16 01:12:13 by jwe]
jwe
parents: 2979
diff changeset
35 // A base class for expressions.
1739
bbfca89cb1cd [project @ 1996-01-12 11:03:26 by jwe]
jwe
parents:
diff changeset
36
bbfca89cb1cd [project @ 1996-01-12 11:03:26 by jwe]
jwe
parents:
diff changeset
37 class
2980
cd5ad3fd8049 [project @ 1997-05-16 01:12:13 by jwe]
jwe
parents: 2979
diff changeset
38 tree_expression : public tree
2388
4be11abb8d8c [project @ 1996-10-12 18:53:51 by jwe]
jwe
parents: 2124
diff changeset
39 {
4be11abb8d8c [project @ 1996-10-12 18:53:51 by jwe]
jwe
parents: 2124
diff changeset
40 public:
4be11abb8d8c [project @ 1996-10-12 18:53:51 by jwe]
jwe
parents: 2124
diff changeset
41
2980
cd5ad3fd8049 [project @ 1997-05-16 01:12:13 by jwe]
jwe
parents: 2979
diff changeset
42 tree_expression (int l = -1, int c = -1)
cd5ad3fd8049 [project @ 1997-05-16 01:12:13 by jwe]
jwe
parents: 2979
diff changeset
43 : tree (l, c), num_parens (0), postfix_indexed (false),
cd5ad3fd8049 [project @ 1997-05-16 01:12:13 by jwe]
jwe
parents: 2979
diff changeset
44 print_flag (false) { }
2388
4be11abb8d8c [project @ 1996-10-12 18:53:51 by jwe]
jwe
parents: 2124
diff changeset
45
2980
cd5ad3fd8049 [project @ 1997-05-16 01:12:13 by jwe]
jwe
parents: 2979
diff changeset
46 virtual ~tree_expression (void) { }
2388
4be11abb8d8c [project @ 1996-10-12 18:53:51 by jwe]
jwe
parents: 2124
diff changeset
47
4267
7cd865a8c815 [project @ 2003-01-03 15:27:05 by jwe]
jwe
parents: 4192
diff changeset
48 virtual bool has_magic_end (void) const = 0;
7cd865a8c815 [project @ 2003-01-03 15:27:05 by jwe]
jwe
parents: 4192
diff changeset
49
7767
71f068b22fcc scope and context fixes for function handles
John W. Eaton <jwe@octave.org>
parents: 7336
diff changeset
50 virtual tree_expression *dup (symbol_table::scope_id,
10313
f3b65e1ae355 untabify src header files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
51 symbol_table::context_id context) const = 0;
5861
2a6cb4ed8f1e [project @ 2006-06-16 05:09:41 by jwe]
jwe
parents: 5307
diff changeset
52
3933
f9ea3dcf58ee [project @ 2002-05-15 03:21:00 by jwe]
jwe
parents: 3523
diff changeset
53 virtual bool is_constant (void) const { return false; }
2388
4be11abb8d8c [project @ 1996-10-12 18:53:51 by jwe]
jwe
parents: 2124
diff changeset
54
3933
f9ea3dcf58ee [project @ 2002-05-15 03:21:00 by jwe]
jwe
parents: 3523
diff changeset
55 virtual bool is_matrix_constant (void) const { return false; }
2388
4be11abb8d8c [project @ 1996-10-12 18:53:51 by jwe]
jwe
parents: 2124
diff changeset
56
3933
f9ea3dcf58ee [project @ 2002-05-15 03:21:00 by jwe]
jwe
parents: 3523
diff changeset
57 virtual bool is_identifier (void) const { return false; }
1739
bbfca89cb1cd [project @ 1996-01-12 11:03:26 by jwe]
jwe
parents:
diff changeset
58
3933
f9ea3dcf58ee [project @ 2002-05-15 03:21:00 by jwe]
jwe
parents: 3523
diff changeset
59 virtual bool is_index_expression (void) const { return false; }
1739
bbfca89cb1cd [project @ 1996-01-12 11:03:26 by jwe]
jwe
parents:
diff changeset
60
3933
f9ea3dcf58ee [project @ 2002-05-15 03:21:00 by jwe]
jwe
parents: 3523
diff changeset
61 virtual bool is_assignment_expression (void) const { return false; }
1739
bbfca89cb1cd [project @ 1996-01-12 11:03:26 by jwe]
jwe
parents:
diff changeset
62
3933
f9ea3dcf58ee [project @ 2002-05-15 03:21:00 by jwe]
jwe
parents: 3523
diff changeset
63 virtual bool is_prefix_expression (void) const { return false; }
1739
bbfca89cb1cd [project @ 1996-01-12 11:03:26 by jwe]
jwe
parents:
diff changeset
64
7800
5861b95e9879 support for compound operators, implement trans_mul, mul_trans, herm_mul and mul_herm
Jaroslav Hajek <highegg@gmail.com>
parents: 7767
diff changeset
65 virtual bool is_unary_expression (void) const { return false; }
5861b95e9879 support for compound operators, implement trans_mul, mul_trans, herm_mul and mul_herm
Jaroslav Hajek <highegg@gmail.com>
parents: 7767
diff changeset
66
4023
ef3caf27cb9c [project @ 2002-08-07 06:54:41 by jwe]
jwe
parents: 3933
diff changeset
67 virtual bool is_binary_expression (void) const { return false; }
ef3caf27cb9c [project @ 2002-08-07 06:54:41 by jwe]
jwe
parents: 3933
diff changeset
68
ef3caf27cb9c [project @ 2002-08-07 06:54:41 by jwe]
jwe
parents: 3933
diff changeset
69 virtual bool is_boolean_expression (void) const { return false; }
ef3caf27cb9c [project @ 2002-08-07 06:54:41 by jwe]
jwe
parents: 3933
diff changeset
70
2980
cd5ad3fd8049 [project @ 1997-05-16 01:12:13 by jwe]
jwe
parents: 2979
diff changeset
71 virtual bool is_logically_true (const char *);
1739
bbfca89cb1cd [project @ 1996-01-12 11:03:26 by jwe]
jwe
parents:
diff changeset
72
3933
f9ea3dcf58ee [project @ 2002-05-15 03:21:00 by jwe]
jwe
parents: 3523
diff changeset
73 virtual bool lvalue_ok (void) const { return false; }
1739
bbfca89cb1cd [project @ 1996-01-12 11:03:26 by jwe]
jwe
parents:
diff changeset
74
3933
f9ea3dcf58ee [project @ 2002-05-15 03:21:00 by jwe]
jwe
parents: 3523
diff changeset
75 virtual bool rvalue_ok (void) const { return false; }
2124
97a566037a75 [project @ 1996-05-12 07:16:36 by jwe]
jwe
parents: 2086
diff changeset
76
8658
73c4516fae10 New evaluator and debugger derived from tree-walker class
John W. Eaton <jwe@octave.org>
parents: 7800
diff changeset
77 virtual octave_value rvalue1 (int nargout = 1);
1739
bbfca89cb1cd [project @ 1996-01-12 11:03:26 by jwe]
jwe
parents:
diff changeset
78
2980
cd5ad3fd8049 [project @ 1997-05-16 01:12:13 by jwe]
jwe
parents: 2979
diff changeset
79 virtual octave_value_list rvalue (int nargout);
2879
4309724baab6 [project @ 1997-04-24 09:30:23 by jwe]
jwe
parents: 2859
diff changeset
80
10832
1b2fcd122c6a allow user detect ignored outputs in m-functions
Jaroslav Hajek <highegg@gmail.com>
parents: 10313
diff changeset
81 virtual octave_value_list rvalue (int nargout,
1b2fcd122c6a allow user detect ignored outputs in m-functions
Jaroslav Hajek <highegg@gmail.com>
parents: 10313
diff changeset
82 const std::list<octave_lvalue> *lvalue_list);
1b2fcd122c6a allow user detect ignored outputs in m-functions
Jaroslav Hajek <highegg@gmail.com>
parents: 10313
diff changeset
83
2980
cd5ad3fd8049 [project @ 1997-05-16 01:12:13 by jwe]
jwe
parents: 2979
diff changeset
84 virtual octave_lvalue lvalue (void);
2879
4309724baab6 [project @ 1997-04-24 09:30:23 by jwe]
jwe
parents: 2859
diff changeset
85
3933
f9ea3dcf58ee [project @ 2002-05-15 03:21:00 by jwe]
jwe
parents: 3523
diff changeset
86 int paren_count (void) const { return num_parens; }
2124
97a566037a75 [project @ 1996-05-12 07:16:36 by jwe]
jwe
parents: 2086
diff changeset
87
3933
f9ea3dcf58ee [project @ 2002-05-15 03:21:00 by jwe]
jwe
parents: 3523
diff changeset
88 bool is_postfix_indexed (void) const { return postfix_indexed; }
2124
97a566037a75 [project @ 1996-05-12 07:16:36 by jwe]
jwe
parents: 2086
diff changeset
89
3933
f9ea3dcf58ee [project @ 2002-05-15 03:21:00 by jwe]
jwe
parents: 3523
diff changeset
90 bool print_result (void) const { return print_flag; }
1739
bbfca89cb1cd [project @ 1996-01-12 11:03:26 by jwe]
jwe
parents:
diff changeset
91
3933
f9ea3dcf58ee [project @ 2002-05-15 03:21:00 by jwe]
jwe
parents: 3523
diff changeset
92 virtual std::string oper (void) const { return "<unknown>"; }
1739
bbfca89cb1cd [project @ 1996-01-12 11:03:26 by jwe]
jwe
parents:
diff changeset
93
3933
f9ea3dcf58ee [project @ 2002-05-15 03:21:00 by jwe]
jwe
parents: 3523
diff changeset
94 virtual std::string name (void) const { return "<unknown>"; }
2124
97a566037a75 [project @ 1996-05-12 07:16:36 by jwe]
jwe
parents: 2086
diff changeset
95
3523
b80bbb43a1a9 [project @ 2000-02-02 10:25:52 by jwe]
jwe
parents: 2988
diff changeset
96 virtual std::string original_text (void) const;
1739
bbfca89cb1cd [project @ 1996-01-12 11:03:26 by jwe]
jwe
parents:
diff changeset
97
11091
5677f3f7b5fa Matlab compatible short-circuit behavior for & and | operators
John W. Eaton <jwe@octave.org>
parents: 10832
diff changeset
98 virtual void mark_braindead_shortcircuit (const std::string&) { }
5677f3f7b5fa Matlab compatible short-circuit behavior for & and | operators
John W. Eaton <jwe@octave.org>
parents: 10832
diff changeset
99
2980
cd5ad3fd8049 [project @ 1997-05-16 01:12:13 by jwe]
jwe
parents: 2979
diff changeset
100 tree_expression *mark_in_parens (void)
1739
bbfca89cb1cd [project @ 1996-01-12 11:03:26 by jwe]
jwe
parents:
diff changeset
101 {
2980
cd5ad3fd8049 [project @ 1997-05-16 01:12:13 by jwe]
jwe
parents: 2979
diff changeset
102 num_parens++;
cd5ad3fd8049 [project @ 1997-05-16 01:12:13 by jwe]
jwe
parents: 2979
diff changeset
103 return this;
1739
bbfca89cb1cd [project @ 1996-01-12 11:03:26 by jwe]
jwe
parents:
diff changeset
104 }
bbfca89cb1cd [project @ 1996-01-12 11:03:26 by jwe]
jwe
parents:
diff changeset
105
2980
cd5ad3fd8049 [project @ 1997-05-16 01:12:13 by jwe]
jwe
parents: 2979
diff changeset
106 tree_expression *mark_postfix_indexed (void)
cd5ad3fd8049 [project @ 1997-05-16 01:12:13 by jwe]
jwe
parents: 2979
diff changeset
107 {
cd5ad3fd8049 [project @ 1997-05-16 01:12:13 by jwe]
jwe
parents: 2979
diff changeset
108 postfix_indexed = true;
cd5ad3fd8049 [project @ 1997-05-16 01:12:13 by jwe]
jwe
parents: 2979
diff changeset
109 return this;
cd5ad3fd8049 [project @ 1997-05-16 01:12:13 by jwe]
jwe
parents: 2979
diff changeset
110 }
2971
f2be17e6f1ea [project @ 1997-05-15 18:55:44 by jwe]
jwe
parents: 2960
diff changeset
111
2980
cd5ad3fd8049 [project @ 1997-05-16 01:12:13 by jwe]
jwe
parents: 2979
diff changeset
112 tree_expression *set_print_flag (bool print)
cd5ad3fd8049 [project @ 1997-05-16 01:12:13 by jwe]
jwe
parents: 2979
diff changeset
113 {
cd5ad3fd8049 [project @ 1997-05-16 01:12:13 by jwe]
jwe
parents: 2979
diff changeset
114 print_flag = print;
cd5ad3fd8049 [project @ 1997-05-16 01:12:13 by jwe]
jwe
parents: 2979
diff changeset
115 return this;
cd5ad3fd8049 [project @ 1997-05-16 01:12:13 by jwe]
jwe
parents: 2979
diff changeset
116 }
2971
f2be17e6f1ea [project @ 1997-05-15 18:55:44 by jwe]
jwe
parents: 2960
diff changeset
117
8913
35cd375d4bb3 make tree::dup functions const
John W. Eaton <jwe@octave.org>
parents: 8658
diff changeset
118 virtual void copy_base (const tree_expression& e)
5861
2a6cb4ed8f1e [project @ 2006-06-16 05:09:41 by jwe]
jwe
parents: 5307
diff changeset
119 {
2a6cb4ed8f1e [project @ 2006-06-16 05:09:41 by jwe]
jwe
parents: 5307
diff changeset
120 num_parens = e.num_parens;
2a6cb4ed8f1e [project @ 2006-06-16 05:09:41 by jwe]
jwe
parents: 5307
diff changeset
121 postfix_indexed = e.postfix_indexed;
2a6cb4ed8f1e [project @ 2006-06-16 05:09:41 by jwe]
jwe
parents: 5307
diff changeset
122 print_flag = e.print_flag;
2a6cb4ed8f1e [project @ 2006-06-16 05:09:41 by jwe]
jwe
parents: 5307
diff changeset
123 }
2a6cb4ed8f1e [project @ 2006-06-16 05:09:41 by jwe]
jwe
parents: 5307
diff changeset
124
2980
cd5ad3fd8049 [project @ 1997-05-16 01:12:13 by jwe]
jwe
parents: 2979
diff changeset
125 protected:
2971
f2be17e6f1ea [project @ 1997-05-15 18:55:44 by jwe]
jwe
parents: 2960
diff changeset
126
2980
cd5ad3fd8049 [project @ 1997-05-16 01:12:13 by jwe]
jwe
parents: 2979
diff changeset
127 // A count of the number of times this expression appears directly
cd5ad3fd8049 [project @ 1997-05-16 01:12:13 by jwe]
jwe
parents: 2979
diff changeset
128 // inside a set of parentheses.
cd5ad3fd8049 [project @ 1997-05-16 01:12:13 by jwe]
jwe
parents: 2979
diff changeset
129 //
cd5ad3fd8049 [project @ 1997-05-16 01:12:13 by jwe]
jwe
parents: 2979
diff changeset
130 // (((e1)) + e2) ==> 2 for expression e1
cd5ad3fd8049 [project @ 1997-05-16 01:12:13 by jwe]
jwe
parents: 2979
diff changeset
131 // ==> 1 for expression ((e1)) + e2
cd5ad3fd8049 [project @ 1997-05-16 01:12:13 by jwe]
jwe
parents: 2979
diff changeset
132 // ==> 0 for expression e2
cd5ad3fd8049 [project @ 1997-05-16 01:12:13 by jwe]
jwe
parents: 2979
diff changeset
133 int num_parens;
2971
f2be17e6f1ea [project @ 1997-05-15 18:55:44 by jwe]
jwe
parents: 2960
diff changeset
134
2980
cd5ad3fd8049 [project @ 1997-05-16 01:12:13 by jwe]
jwe
parents: 2979
diff changeset
135 // A flag that says whether this expression has an index associated
cd5ad3fd8049 [project @ 1997-05-16 01:12:13 by jwe]
jwe
parents: 2979
diff changeset
136 // with it. See the code in tree_identifier::rvalue for the rationale.
cd5ad3fd8049 [project @ 1997-05-16 01:12:13 by jwe]
jwe
parents: 2979
diff changeset
137 bool postfix_indexed;
2971
f2be17e6f1ea [project @ 1997-05-15 18:55:44 by jwe]
jwe
parents: 2960
diff changeset
138
2980
cd5ad3fd8049 [project @ 1997-05-16 01:12:13 by jwe]
jwe
parents: 2979
diff changeset
139 // Print result of rvalue for this expression?
cd5ad3fd8049 [project @ 1997-05-16 01:12:13 by jwe]
jwe
parents: 2979
diff changeset
140 bool print_flag;
2988
daa1ed1f5462 [project @ 1997-05-16 07:23:15 by jwe]
jwe
parents: 2980
diff changeset
141
daa1ed1f5462 [project @ 1997-05-16 07:23:15 by jwe]
jwe
parents: 2980
diff changeset
142 private:
daa1ed1f5462 [project @ 1997-05-16 07:23:15 by jwe]
jwe
parents: 2980
diff changeset
143
daa1ed1f5462 [project @ 1997-05-16 07:23:15 by jwe]
jwe
parents: 2980
diff changeset
144 // No copying!
daa1ed1f5462 [project @ 1997-05-16 07:23:15 by jwe]
jwe
parents: 2980
diff changeset
145
daa1ed1f5462 [project @ 1997-05-16 07:23:15 by jwe]
jwe
parents: 2980
diff changeset
146 tree_expression (const tree_expression&);
daa1ed1f5462 [project @ 1997-05-16 07:23:15 by jwe]
jwe
parents: 2980
diff changeset
147
daa1ed1f5462 [project @ 1997-05-16 07:23:15 by jwe]
jwe
parents: 2980
diff changeset
148 tree_expression& operator = (const tree_expression&);
2971
f2be17e6f1ea [project @ 1997-05-15 18:55:44 by jwe]
jwe
parents: 2960
diff changeset
149 };
f2be17e6f1ea [project @ 1997-05-15 18:55:44 by jwe]
jwe
parents: 2960
diff changeset
150
1739
bbfca89cb1cd [project @ 1996-01-12 11:03:26 by jwe]
jwe
parents:
diff changeset
151 #endif