annotate libinterp/parse-tree/pt-cmd.h @ 22323:bac0d6f07a3e

maint: Update copyright notices for 2016.
author John W. Eaton <jwe@octave.org>
date Wed, 17 Aug 2016 01:05:19 -0400
parents 1473547f50f5
children 34ce5be04942
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
494
2c4d694b87e9 [project @ 1994-07-06 14:55:23 by jwe]
jwe
parents:
diff changeset
1 /*
2c4d694b87e9 [project @ 1994-07-06 14:55:23 by jwe]
jwe
parents:
diff changeset
2
22323
bac0d6f07a3e maint: Update copyright notices for 2016.
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
3 Copyright (C) 1994-2016 John W. Eaton
494
2c4d694b87e9 [project @ 1994-07-06 14:55:23 by jwe]
jwe
parents:
diff changeset
4
2c4d694b87e9 [project @ 1994-07-06 14:55:23 by jwe]
jwe
parents:
diff changeset
5 This file is part of Octave.
2c4d694b87e9 [project @ 1994-07-06 14:55:23 by jwe]
jwe
parents:
diff changeset
6
2c4d694b87e9 [project @ 1994-07-06 14:55:23 by jwe]
jwe
parents:
diff changeset
7 Octave is free software; you can redistribute it and/or modify it
2c4d694b87e9 [project @ 1994-07-06 14:55:23 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.
494
2c4d694b87e9 [project @ 1994-07-06 14:55:23 by jwe]
jwe
parents:
diff changeset
11
2c4d694b87e9 [project @ 1994-07-06 14:55:23 by jwe]
jwe
parents:
diff changeset
12 Octave is distributed in the hope that it will be useful, but WITHOUT
2c4d694b87e9 [project @ 1994-07-06 14:55:23 by jwe]
jwe
parents:
diff changeset
13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
2c4d694b87e9 [project @ 1994-07-06 14:55:23 by jwe]
jwe
parents:
diff changeset
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
2c4d694b87e9 [project @ 1994-07-06 14:55:23 by jwe]
jwe
parents:
diff changeset
15 for more details.
2c4d694b87e9 [project @ 1994-07-06 14:55:23 by jwe]
jwe
parents:
diff changeset
16
2c4d694b87e9 [project @ 1994-07-06 14:55:23 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/>.
494
2c4d694b87e9 [project @ 1994-07-06 14:55:23 by jwe]
jwe
parents:
diff changeset
20
2c4d694b87e9 [project @ 1994-07-06 14:55:23 by jwe]
jwe
parents:
diff changeset
21 */
2c4d694b87e9 [project @ 1994-07-06 14:55:23 by jwe]
jwe
parents:
diff changeset
22
20791
f7084eae3318 maint: Use Octave coding conventions for #if statements.
Rik <rik@octave.org>
parents: 19697
diff changeset
23 #if ! defined (octave_pt_cmd_h)
17822
ebb3ef964372 maint: Use common #define syntax "octave_filename_h" in h_files.
Rik <rik@octave.org>
parents: 17744
diff changeset
24 #define octave_pt_cmd_h 1
494
2c4d694b87e9 [project @ 1994-07-06 14:55:23 by jwe]
jwe
parents:
diff changeset
25
21244
1473547f50f5 include octave-config.h in public header files
John W. Eaton <jwe@octave.org>
parents: 20791
diff changeset
26 #include "octave-config.h"
1473547f50f5 include octave-config.h in public header files
John W. Eaton <jwe@octave.org>
parents: 20791
diff changeset
27
2982
20f5cec4f11c [project @ 1997-05-16 03:29:26 by jwe]
jwe
parents: 2979
diff changeset
28 #include <string>
494
2c4d694b87e9 [project @ 1994-07-06 14:55:23 by jwe]
jwe
parents:
diff changeset
29
2124
97a566037a75 [project @ 1996-05-12 07:16:36 by jwe]
jwe
parents: 2086
diff changeset
30 class tree_walker;
97a566037a75 [project @ 1996-05-12 07:16:36 by jwe]
jwe
parents: 2086
diff changeset
31
7715
5b4d278ec828 parse scripts completely before executing
John W. Eaton <jwe@octave.org>
parents: 7336
diff changeset
32 #include "ov-fcn.h"
2988
daa1ed1f5462 [project @ 1997-05-16 07:23:15 by jwe]
jwe
parents: 2982
diff changeset
33 #include "pt.h"
3770
bf6116ca10eb [project @ 2001-02-02 02:21:40 by jwe]
jwe
parents: 3523
diff changeset
34 #include "pt-bp.h"
7336
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7017
diff changeset
35 #include "symtab.h"
578
d169be9237fb [project @ 1994-08-03 20:06:54 by jwe]
jwe
parents: 529
diff changeset
36
d169be9237fb [project @ 1994-08-03 20:06:54 by jwe]
jwe
parents: 529
diff changeset
37 // A base class for commands.
d169be9237fb [project @ 1994-08-03 20:06:54 by jwe]
jwe
parents: 529
diff changeset
38
494
2c4d694b87e9 [project @ 1994-07-06 14:55:23 by jwe]
jwe
parents:
diff changeset
39 class
2c4d694b87e9 [project @ 1994-07-06 14:55:23 by jwe]
jwe
parents:
diff changeset
40 tree_command : public tree
2c4d694b87e9 [project @ 1994-07-06 14:55:23 by jwe]
jwe
parents:
diff changeset
41 {
578
d169be9237fb [project @ 1994-08-03 20:06:54 by jwe]
jwe
parents: 529
diff changeset
42 public:
2124
97a566037a75 [project @ 1996-05-12 07:16:36 by jwe]
jwe
parents: 2086
diff changeset
43
2982
20f5cec4f11c [project @ 1997-05-16 03:29:26 by jwe]
jwe
parents: 2979
diff changeset
44 tree_command (int l = -1, int c = -1)
20f5cec4f11c [project @ 1997-05-16 03:29:26 by jwe]
jwe
parents: 2979
diff changeset
45 : tree (l, c) { }
578
d169be9237fb [project @ 1994-08-03 20:06:54 by jwe]
jwe
parents: 529
diff changeset
46
1270
0a5e9e8892a0 [project @ 1995-04-20 19:23:24 by jwe]
jwe
parents: 1228
diff changeset
47 virtual ~tree_command (void) { }
0a5e9e8892a0 [project @ 1995-04-20 19:23:24 by jwe]
jwe
parents: 1228
diff changeset
48
7767
71f068b22fcc scope and context fixes for function handles
John W. Eaton <jwe@octave.org>
parents: 7715
diff changeset
49 virtual tree_command *dup (symbol_table::scope_id,
10313
f3b65e1ae355 untabify src header files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
50 symbol_table::context_id context) const = 0;
5861
2a6cb4ed8f1e [project @ 2006-06-16 05:09:41 by jwe]
jwe
parents: 5307
diff changeset
51
2988
daa1ed1f5462 [project @ 1997-05-16 07:23:15 by jwe]
jwe
parents: 2982
diff changeset
52 private:
daa1ed1f5462 [project @ 1997-05-16 07:23:15 by jwe]
jwe
parents: 2982
diff changeset
53
daa1ed1f5462 [project @ 1997-05-16 07:23:15 by jwe]
jwe
parents: 2982
diff changeset
54 // No copying!
daa1ed1f5462 [project @ 1997-05-16 07:23:15 by jwe]
jwe
parents: 2982
diff changeset
55
daa1ed1f5462 [project @ 1997-05-16 07:23:15 by jwe]
jwe
parents: 2982
diff changeset
56 tree_command (const tree_command&);
daa1ed1f5462 [project @ 1997-05-16 07:23:15 by jwe]
jwe
parents: 2982
diff changeset
57
daa1ed1f5462 [project @ 1997-05-16 07:23:15 by jwe]
jwe
parents: 2982
diff changeset
58 tree_command& operator = (const tree_command&);
494
2c4d694b87e9 [project @ 1994-07-06 14:55:23 by jwe]
jwe
parents:
diff changeset
59 };
2c4d694b87e9 [project @ 1994-07-06 14:55:23 by jwe]
jwe
parents:
diff changeset
60
2620
5c773d4745d6 [project @ 1997-01-23 16:26:25 by jwe]
jwe
parents: 2124
diff changeset
61 // No-op.
5c773d4745d6 [project @ 1997-01-23 16:26:25 by jwe]
jwe
parents: 2124
diff changeset
62
5c773d4745d6 [project @ 1997-01-23 16:26:25 by jwe]
jwe
parents: 2124
diff changeset
63 class
5c773d4745d6 [project @ 1997-01-23 16:26:25 by jwe]
jwe
parents: 2124
diff changeset
64 tree_no_op_command : public tree_command
5c773d4745d6 [project @ 1997-01-23 16:26:25 by jwe]
jwe
parents: 2124
diff changeset
65 {
5c773d4745d6 [project @ 1997-01-23 16:26:25 by jwe]
jwe
parents: 2124
diff changeset
66 public:
5c773d4745d6 [project @ 1997-01-23 16:26:25 by jwe]
jwe
parents: 2124
diff changeset
67
16627
de91b1621260 adjust location of eof marker for files with subfunctions but no explicit end statements
John W. Eaton <jwe@octave.org>
parents: 15195
diff changeset
68 tree_no_op_command (const std::string& cmd = "no_op", bool e = false,
de91b1621260 adjust location of eof marker for files with subfunctions but no explicit end statements
John W. Eaton <jwe@octave.org>
parents: 15195
diff changeset
69 int l = -1, int c = -1)
de91b1621260 adjust location of eof marker for files with subfunctions but no explicit end statements
John W. Eaton <jwe@octave.org>
parents: 15195
diff changeset
70 : tree_command (l, c), eof (e), orig_cmd (cmd) { }
2620
5c773d4745d6 [project @ 1997-01-23 16:26:25 by jwe]
jwe
parents: 2124
diff changeset
71
5c773d4745d6 [project @ 1997-01-23 16:26:25 by jwe]
jwe
parents: 2124
diff changeset
72 ~tree_no_op_command (void) { }
5c773d4745d6 [project @ 1997-01-23 16:26:25 by jwe]
jwe
parents: 2124
diff changeset
73
7767
71f068b22fcc scope and context fixes for function handles
John W. Eaton <jwe@octave.org>
parents: 7715
diff changeset
74 tree_command *dup (symbol_table::scope_id scope,
10313
f3b65e1ae355 untabify src header files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
75 symbol_table::context_id context) const;
5861
2a6cb4ed8f1e [project @ 2006-06-16 05:09:41 by jwe]
jwe
parents: 5307
diff changeset
76
2620
5c773d4745d6 [project @ 1997-01-23 16:26:25 by jwe]
jwe
parents: 2124
diff changeset
77 void accept (tree_walker& tw);
5c773d4745d6 [project @ 1997-01-23 16:26:25 by jwe]
jwe
parents: 2124
diff changeset
78
16627
de91b1621260 adjust location of eof marker for files with subfunctions but no explicit end statements
John W. Eaton <jwe@octave.org>
parents: 15195
diff changeset
79 bool is_end_of_fcn_or_script (void) const
de91b1621260 adjust location of eof marker for files with subfunctions but no explicit end statements
John W. Eaton <jwe@octave.org>
parents: 15195
diff changeset
80 {
de91b1621260 adjust location of eof marker for files with subfunctions but no explicit end statements
John W. Eaton <jwe@octave.org>
parents: 15195
diff changeset
81 return (orig_cmd == "endfunction" || orig_cmd == "endscript");
de91b1621260 adjust location of eof marker for files with subfunctions but no explicit end statements
John W. Eaton <jwe@octave.org>
parents: 15195
diff changeset
82 }
de91b1621260 adjust location of eof marker for files with subfunctions but no explicit end statements
John W. Eaton <jwe@octave.org>
parents: 15195
diff changeset
83
de91b1621260 adjust location of eof marker for files with subfunctions but no explicit end statements
John W. Eaton <jwe@octave.org>
parents: 15195
diff changeset
84 bool is_end_of_file (void) const { return eof; }
8844
c84a5b6377c4 better handling of end of script/function no-op command
John W. Eaton <jwe@octave.org>
parents: 8658
diff changeset
85
3523
b80bbb43a1a9 [project @ 2000-02-02 10:25:52 by jwe]
jwe
parents: 2988
diff changeset
86 std::string original_command (void) { return orig_cmd; }
2620
5c773d4745d6 [project @ 1997-01-23 16:26:25 by jwe]
jwe
parents: 2124
diff changeset
87
5c773d4745d6 [project @ 1997-01-23 16:26:25 by jwe]
jwe
parents: 2124
diff changeset
88 private:
5c773d4745d6 [project @ 1997-01-23 16:26:25 by jwe]
jwe
parents: 2124
diff changeset
89
8844
c84a5b6377c4 better handling of end of script/function no-op command
John W. Eaton <jwe@octave.org>
parents: 8658
diff changeset
90 bool eof;
c84a5b6377c4 better handling of end of script/function no-op command
John W. Eaton <jwe@octave.org>
parents: 8658
diff changeset
91
3523
b80bbb43a1a9 [project @ 2000-02-02 10:25:52 by jwe]
jwe
parents: 2988
diff changeset
92 std::string orig_cmd;
2988
daa1ed1f5462 [project @ 1997-05-16 07:23:15 by jwe]
jwe
parents: 2982
diff changeset
93
daa1ed1f5462 [project @ 1997-05-16 07:23:15 by jwe]
jwe
parents: 2982
diff changeset
94 // No copying!
daa1ed1f5462 [project @ 1997-05-16 07:23:15 by jwe]
jwe
parents: 2982
diff changeset
95
daa1ed1f5462 [project @ 1997-05-16 07:23:15 by jwe]
jwe
parents: 2982
diff changeset
96 tree_no_op_command (const tree_no_op_command&);
daa1ed1f5462 [project @ 1997-05-16 07:23:15 by jwe]
jwe
parents: 2982
diff changeset
97
daa1ed1f5462 [project @ 1997-05-16 07:23:15 by jwe]
jwe
parents: 2982
diff changeset
98 tree_no_op_command& operator = (const tree_no_op_command&);
2620
5c773d4745d6 [project @ 1997-01-23 16:26:25 by jwe]
jwe
parents: 2124
diff changeset
99 };
5c773d4745d6 [project @ 1997-01-23 16:26:25 by jwe]
jwe
parents: 2124
diff changeset
100
7715
5b4d278ec828 parse scripts completely before executing
John W. Eaton <jwe@octave.org>
parents: 7336
diff changeset
101 // Function definition.
5b4d278ec828 parse scripts completely before executing
John W. Eaton <jwe@octave.org>
parents: 7336
diff changeset
102
5b4d278ec828 parse scripts completely before executing
John W. Eaton <jwe@octave.org>
parents: 7336
diff changeset
103 class
5b4d278ec828 parse scripts completely before executing
John W. Eaton <jwe@octave.org>
parents: 7336
diff changeset
104 tree_function_def : public tree_command
5b4d278ec828 parse scripts completely before executing
John W. Eaton <jwe@octave.org>
parents: 7336
diff changeset
105 {
5b4d278ec828 parse scripts completely before executing
John W. Eaton <jwe@octave.org>
parents: 7336
diff changeset
106 public:
5b4d278ec828 parse scripts completely before executing
John W. Eaton <jwe@octave.org>
parents: 7336
diff changeset
107
5b4d278ec828 parse scripts completely before executing
John W. Eaton <jwe@octave.org>
parents: 7336
diff changeset
108 tree_function_def (octave_function *f, int l = -1, int c = -1)
5b4d278ec828 parse scripts completely before executing
John W. Eaton <jwe@octave.org>
parents: 7336
diff changeset
109 : tree_command (l, c), fcn (f) { }
5b4d278ec828 parse scripts completely before executing
John W. Eaton <jwe@octave.org>
parents: 7336
diff changeset
110
5b4d278ec828 parse scripts completely before executing
John W. Eaton <jwe@octave.org>
parents: 7336
diff changeset
111 ~tree_function_def (void) { }
5b4d278ec828 parse scripts completely before executing
John W. Eaton <jwe@octave.org>
parents: 7336
diff changeset
112
7767
71f068b22fcc scope and context fixes for function handles
John W. Eaton <jwe@octave.org>
parents: 7715
diff changeset
113 tree_command *dup (symbol_table::scope_id scope,
10313
f3b65e1ae355 untabify src header files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
114 symbol_table::context_id context) const;
7715
5b4d278ec828 parse scripts completely before executing
John W. Eaton <jwe@octave.org>
parents: 7336
diff changeset
115
5b4d278ec828 parse scripts completely before executing
John W. Eaton <jwe@octave.org>
parents: 7336
diff changeset
116 void accept (tree_walker& tw);
5b4d278ec828 parse scripts completely before executing
John W. Eaton <jwe@octave.org>
parents: 7336
diff changeset
117
8658
73c4516fae10 New evaluator and debugger derived from tree-walker class
John W. Eaton <jwe@octave.org>
parents: 7767
diff changeset
118 octave_value function (void) { return fcn; }
7715
5b4d278ec828 parse scripts completely before executing
John W. Eaton <jwe@octave.org>
parents: 7336
diff changeset
119
5b4d278ec828 parse scripts completely before executing
John W. Eaton <jwe@octave.org>
parents: 7336
diff changeset
120 private:
5b4d278ec828 parse scripts completely before executing
John W. Eaton <jwe@octave.org>
parents: 7336
diff changeset
121
5b4d278ec828 parse scripts completely before executing
John W. Eaton <jwe@octave.org>
parents: 7336
diff changeset
122 octave_value fcn;
5b4d278ec828 parse scripts completely before executing
John W. Eaton <jwe@octave.org>
parents: 7336
diff changeset
123
5b4d278ec828 parse scripts completely before executing
John W. Eaton <jwe@octave.org>
parents: 7336
diff changeset
124 tree_function_def (const octave_value& v, int l = -1, int c = -1)
5b4d278ec828 parse scripts completely before executing
John W. Eaton <jwe@octave.org>
parents: 7336
diff changeset
125 : tree_command (l, c), fcn (v) { }
5b4d278ec828 parse scripts completely before executing
John W. Eaton <jwe@octave.org>
parents: 7336
diff changeset
126
5b4d278ec828 parse scripts completely before executing
John W. Eaton <jwe@octave.org>
parents: 7336
diff changeset
127 // No copying!
5b4d278ec828 parse scripts completely before executing
John W. Eaton <jwe@octave.org>
parents: 7336
diff changeset
128
5b4d278ec828 parse scripts completely before executing
John W. Eaton <jwe@octave.org>
parents: 7336
diff changeset
129 tree_function_def (const tree_function_def&);
5b4d278ec828 parse scripts completely before executing
John W. Eaton <jwe@octave.org>
parents: 7336
diff changeset
130
5b4d278ec828 parse scripts completely before executing
John W. Eaton <jwe@octave.org>
parents: 7336
diff changeset
131 tree_function_def& operator = (const tree_function_def&);
5b4d278ec828 parse scripts completely before executing
John W. Eaton <jwe@octave.org>
parents: 7336
diff changeset
132 };
5b4d278ec828 parse scripts completely before executing
John W. Eaton <jwe@octave.org>
parents: 7336
diff changeset
133
494
2c4d694b87e9 [project @ 1994-07-06 14:55:23 by jwe]
jwe
parents:
diff changeset
134 #endif