annotate src/toplev.h @ 5743:a527e0f77aa5

[project @ 2006-04-06 08:20:21 by jwe]
author jwe
date Thu, 06 Apr 2006 08:20:23 +0000
parents 4c8a2e4e0717
children 1c36a2e82266
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
1 /*
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
2
2847
8b262e771614 [project @ 1997-03-27 16:18:26 by jwe]
jwe
parents: 2806
diff changeset
3 Copyright (C) 1996, 1997 John W. Eaton
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
4
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
5 This file is part of Octave.
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
6
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
7 Octave is free software; you can redistribute it and/or modify it
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
8 under the terms of the GNU General Public License as published by the
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
9 Free Software Foundation; either version 2, or (at your option) any
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
10 later version.
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
11
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
12 Octave is distributed in the hope that it will be useful, but WITHOUT
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
15 for more details.
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
16
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
17 You should have received a copy of the GNU General Public License
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
18 along with Octave; see the file COPYING. If not, write to the Free
5307
4c8a2e4e0717 [project @ 2005-04-26 19:24:27 by jwe]
jwe
parents: 5189
diff changeset
19 Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
4c8a2e4e0717 [project @ 2005-04-26 19:24:27 by jwe]
jwe
parents: 5189
diff changeset
20 02110-1301, USA.
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
21
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
22 */
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
23
1670
6708c53892c1 [project @ 1995-12-27 04:33:00 by jwe]
jwe
parents: 1613
diff changeset
24 #if !defined (octave_toplev_h)
6708c53892c1 [project @ 1995-12-27 04:33:00 by jwe]
jwe
parents: 1613
diff changeset
25 #define octave_toplev_h 1
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
26
1355
94697d007075 [project @ 1995-09-05 20:04:15 by jwe]
jwe
parents: 1315
diff changeset
27 #include <cstdio>
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
28
5743
a527e0f77aa5 [project @ 2006-04-06 08:20:21 by jwe]
jwe
parents: 5307
diff changeset
29 #include <list>
3503
d14c483b3c12 [project @ 2000-02-01 04:06:07 by jwe]
jwe
parents: 3216
diff changeset
30 #include <string>
d14c483b3c12 [project @ 2000-02-01 04:06:07 by jwe]
jwe
parents: 3216
diff changeset
31
2086
bfb775fb6fe8 [project @ 1996-04-25 05:55:19 by jwe]
jwe
parents: 2077
diff changeset
32 class octave_value;
2796
74bc1ede3c3d [project @ 1997-03-07 06:55:47 by jwe]
jwe
parents: 2440
diff changeset
33 class octave_value_list;
5743
a527e0f77aa5 [project @ 2006-04-06 08:20:21 by jwe]
jwe
parents: 5307
diff changeset
34 class octave_function;
2891
1a30f46e1870 [project @ 1997-04-28 01:49:00 by jwe]
jwe
parents: 2859
diff changeset
35 class octave_user_function;
578
d169be9237fb [project @ 1994-08-03 20:06:54 by jwe]
jwe
parents: 574
diff changeset
36 class tree_statement_list;
1572
0d9e10d10bd7 [project @ 1995-10-19 04:31:30 by jwe]
jwe
parents: 1516
diff changeset
37 class charMatrix;
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
38
2796
74bc1ede3c3d [project @ 1997-03-07 06:55:47 by jwe]
jwe
parents: 2440
diff changeset
39 extern void
74bc1ede3c3d [project @ 1997-03-07 06:55:47 by jwe]
jwe
parents: 2440
diff changeset
40 clean_up_and_exit (int) GCC_ATTR_NORETURN;
574
a10f1c8ab10f [project @ 1994-07-29 18:29:13 by jwe]
jwe
parents: 383
diff changeset
41
5189
85b315ad5f7d [project @ 2005-03-04 02:46:08 by jwe]
jwe
parents: 4975
diff changeset
42 extern int main_loop (void);
1907
8c6cea97eb80 [project @ 1996-02-10 01:12:46 by jwe]
jwe
parents: 1884
diff changeset
43
2796
74bc1ede3c3d [project @ 1997-03-07 06:55:47 by jwe]
jwe
parents: 2440
diff changeset
44 extern void
74bc1ede3c3d [project @ 1997-03-07 06:55:47 by jwe]
jwe
parents: 2440
diff changeset
45 do_octave_atexit (void);
2077
2d03b8eb891d [project @ 1996-04-24 00:21:21 by jwe]
jwe
parents: 1996
diff changeset
46
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
47 // Current command to execute.
578
d169be9237fb [project @ 1994-08-03 20:06:54 by jwe]
jwe
parents: 574
diff changeset
48 extern tree_statement_list *global_command;
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
49
4238
a5a68c0afe56 [project @ 2002-12-25 21:04:33 by jwe]
jwe
parents: 4217
diff changeset
50 // Pointer to parent function that is currently being evaluated.
4748
7b145222fea3 [project @ 2004-02-07 06:27:27 by jwe]
jwe
parents: 4399
diff changeset
51 extern octave_function *curr_parent_function;
4238
a5a68c0afe56 [project @ 2002-12-25 21:04:33 by jwe]
jwe
parents: 4217
diff changeset
52
4217
301cc4cf87e9 [project @ 2002-12-05 03:33:01 by jwe]
jwe
parents: 4172
diff changeset
53 // TRUE means we are ready to interpret commands, but not everything
301cc4cf87e9 [project @ 2002-12-05 03:33:01 by jwe]
jwe
parents: 4172
diff changeset
54 // is ready for interactive use.
301cc4cf87e9 [project @ 2002-12-05 03:33:01 by jwe]
jwe
parents: 4172
diff changeset
55 extern bool octave_interpreter_ready;
301cc4cf87e9 [project @ 2002-12-05 03:33:01 by jwe]
jwe
parents: 4172
diff changeset
56
4172
2e94b2abfe6d [project @ 2002-11-12 21:14:04 by jwe]
jwe
parents: 3834
diff changeset
57 // TRUE means we've processed all the init code and we are good to go.
2e94b2abfe6d [project @ 2002-11-12 21:14:04 by jwe]
jwe
parents: 3834
diff changeset
58 extern bool octave_initialized;
2e94b2abfe6d [project @ 2002-11-12 21:14:04 by jwe]
jwe
parents: 3834
diff changeset
59
5743
a527e0f77aa5 [project @ 2006-04-06 08:20:21 by jwe]
jwe
parents: 5307
diff changeset
60 class
a527e0f77aa5 [project @ 2006-04-06 08:20:21 by jwe]
jwe
parents: 5307
diff changeset
61 octave_call_stack
a527e0f77aa5 [project @ 2006-04-06 08:20:21 by jwe]
jwe
parents: 5307
diff changeset
62 {
a527e0f77aa5 [project @ 2006-04-06 08:20:21 by jwe]
jwe
parents: 5307
diff changeset
63 protected:
a527e0f77aa5 [project @ 2006-04-06 08:20:21 by jwe]
jwe
parents: 5307
diff changeset
64
a527e0f77aa5 [project @ 2006-04-06 08:20:21 by jwe]
jwe
parents: 5307
diff changeset
65 octave_call_stack (void) : cs () { }
a527e0f77aa5 [project @ 2006-04-06 08:20:21 by jwe]
jwe
parents: 5307
diff changeset
66
a527e0f77aa5 [project @ 2006-04-06 08:20:21 by jwe]
jwe
parents: 5307
diff changeset
67 public:
a527e0f77aa5 [project @ 2006-04-06 08:20:21 by jwe]
jwe
parents: 5307
diff changeset
68
a527e0f77aa5 [project @ 2006-04-06 08:20:21 by jwe]
jwe
parents: 5307
diff changeset
69 typedef std::list<octave_function *>::iterator iterator ;
a527e0f77aa5 [project @ 2006-04-06 08:20:21 by jwe]
jwe
parents: 5307
diff changeset
70
a527e0f77aa5 [project @ 2006-04-06 08:20:21 by jwe]
jwe
parents: 5307
diff changeset
71 static bool instance_ok (void)
a527e0f77aa5 [project @ 2006-04-06 08:20:21 by jwe]
jwe
parents: 5307
diff changeset
72 {
a527e0f77aa5 [project @ 2006-04-06 08:20:21 by jwe]
jwe
parents: 5307
diff changeset
73 bool retval = true;
a527e0f77aa5 [project @ 2006-04-06 08:20:21 by jwe]
jwe
parents: 5307
diff changeset
74
a527e0f77aa5 [project @ 2006-04-06 08:20:21 by jwe]
jwe
parents: 5307
diff changeset
75 if (! instance)
a527e0f77aa5 [project @ 2006-04-06 08:20:21 by jwe]
jwe
parents: 5307
diff changeset
76 instance = new octave_call_stack ();
a527e0f77aa5 [project @ 2006-04-06 08:20:21 by jwe]
jwe
parents: 5307
diff changeset
77
a527e0f77aa5 [project @ 2006-04-06 08:20:21 by jwe]
jwe
parents: 5307
diff changeset
78 if (! instance)
a527e0f77aa5 [project @ 2006-04-06 08:20:21 by jwe]
jwe
parents: 5307
diff changeset
79 {
a527e0f77aa5 [project @ 2006-04-06 08:20:21 by jwe]
jwe
parents: 5307
diff changeset
80 ::error ("unable to create call stack object!");
a527e0f77aa5 [project @ 2006-04-06 08:20:21 by jwe]
jwe
parents: 5307
diff changeset
81
a527e0f77aa5 [project @ 2006-04-06 08:20:21 by jwe]
jwe
parents: 5307
diff changeset
82 retval = false;
a527e0f77aa5 [project @ 2006-04-06 08:20:21 by jwe]
jwe
parents: 5307
diff changeset
83 }
a527e0f77aa5 [project @ 2006-04-06 08:20:21 by jwe]
jwe
parents: 5307
diff changeset
84
a527e0f77aa5 [project @ 2006-04-06 08:20:21 by jwe]
jwe
parents: 5307
diff changeset
85 return retval;
a527e0f77aa5 [project @ 2006-04-06 08:20:21 by jwe]
jwe
parents: 5307
diff changeset
86 }
a527e0f77aa5 [project @ 2006-04-06 08:20:21 by jwe]
jwe
parents: 5307
diff changeset
87
a527e0f77aa5 [project @ 2006-04-06 08:20:21 by jwe]
jwe
parents: 5307
diff changeset
88 // Current function (top of stack).
a527e0f77aa5 [project @ 2006-04-06 08:20:21 by jwe]
jwe
parents: 5307
diff changeset
89 static octave_function *current (void)
a527e0f77aa5 [project @ 2006-04-06 08:20:21 by jwe]
jwe
parents: 5307
diff changeset
90 {
a527e0f77aa5 [project @ 2006-04-06 08:20:21 by jwe]
jwe
parents: 5307
diff changeset
91 return instance_ok () ? instance->do_current (): 0;
a527e0f77aa5 [project @ 2006-04-06 08:20:21 by jwe]
jwe
parents: 5307
diff changeset
92 }
a527e0f77aa5 [project @ 2006-04-06 08:20:21 by jwe]
jwe
parents: 5307
diff changeset
93
a527e0f77aa5 [project @ 2006-04-06 08:20:21 by jwe]
jwe
parents: 5307
diff changeset
94 // Caller function, may be built-in.
a527e0f77aa5 [project @ 2006-04-06 08:20:21 by jwe]
jwe
parents: 5307
diff changeset
95 static octave_function *caller (void)
a527e0f77aa5 [project @ 2006-04-06 08:20:21 by jwe]
jwe
parents: 5307
diff changeset
96 {
a527e0f77aa5 [project @ 2006-04-06 08:20:21 by jwe]
jwe
parents: 5307
diff changeset
97 return instance_ok () ? instance->do_caller (): 0;
a527e0f77aa5 [project @ 2006-04-06 08:20:21 by jwe]
jwe
parents: 5307
diff changeset
98 }
a527e0f77aa5 [project @ 2006-04-06 08:20:21 by jwe]
jwe
parents: 5307
diff changeset
99
a527e0f77aa5 [project @ 2006-04-06 08:20:21 by jwe]
jwe
parents: 5307
diff changeset
100 // First scripting language function on the stack.
a527e0f77aa5 [project @ 2006-04-06 08:20:21 by jwe]
jwe
parents: 5307
diff changeset
101 static octave_user_function *caller_script (void)
a527e0f77aa5 [project @ 2006-04-06 08:20:21 by jwe]
jwe
parents: 5307
diff changeset
102 {
a527e0f77aa5 [project @ 2006-04-06 08:20:21 by jwe]
jwe
parents: 5307
diff changeset
103 return instance_ok () ? instance->do_caller_script (): 0;
a527e0f77aa5 [project @ 2006-04-06 08:20:21 by jwe]
jwe
parents: 5307
diff changeset
104 }
a527e0f77aa5 [project @ 2006-04-06 08:20:21 by jwe]
jwe
parents: 5307
diff changeset
105
a527e0f77aa5 [project @ 2006-04-06 08:20:21 by jwe]
jwe
parents: 5307
diff changeset
106 static void push (octave_function *f)
a527e0f77aa5 [project @ 2006-04-06 08:20:21 by jwe]
jwe
parents: 5307
diff changeset
107 {
a527e0f77aa5 [project @ 2006-04-06 08:20:21 by jwe]
jwe
parents: 5307
diff changeset
108 if (instance_ok ())
a527e0f77aa5 [project @ 2006-04-06 08:20:21 by jwe]
jwe
parents: 5307
diff changeset
109 instance->do_push (f);
a527e0f77aa5 [project @ 2006-04-06 08:20:21 by jwe]
jwe
parents: 5307
diff changeset
110 }
a527e0f77aa5 [project @ 2006-04-06 08:20:21 by jwe]
jwe
parents: 5307
diff changeset
111
a527e0f77aa5 [project @ 2006-04-06 08:20:21 by jwe]
jwe
parents: 5307
diff changeset
112 static void pop (void)
a527e0f77aa5 [project @ 2006-04-06 08:20:21 by jwe]
jwe
parents: 5307
diff changeset
113 {
a527e0f77aa5 [project @ 2006-04-06 08:20:21 by jwe]
jwe
parents: 5307
diff changeset
114 if (instance_ok ())
a527e0f77aa5 [project @ 2006-04-06 08:20:21 by jwe]
jwe
parents: 5307
diff changeset
115 instance->do_pop ();
a527e0f77aa5 [project @ 2006-04-06 08:20:21 by jwe]
jwe
parents: 5307
diff changeset
116 }
a527e0f77aa5 [project @ 2006-04-06 08:20:21 by jwe]
jwe
parents: 5307
diff changeset
117
a527e0f77aa5 [project @ 2006-04-06 08:20:21 by jwe]
jwe
parents: 5307
diff changeset
118 // A function for popping the top of the call stack that is suitable
a527e0f77aa5 [project @ 2006-04-06 08:20:21 by jwe]
jwe
parents: 5307
diff changeset
119 // for use as an unwind_protect handler.
a527e0f77aa5 [project @ 2006-04-06 08:20:21 by jwe]
jwe
parents: 5307
diff changeset
120 static void unwind_pop (void *) { pop (); }
a527e0f77aa5 [project @ 2006-04-06 08:20:21 by jwe]
jwe
parents: 5307
diff changeset
121
a527e0f77aa5 [project @ 2006-04-06 08:20:21 by jwe]
jwe
parents: 5307
diff changeset
122 static void clear (void)
a527e0f77aa5 [project @ 2006-04-06 08:20:21 by jwe]
jwe
parents: 5307
diff changeset
123 {
a527e0f77aa5 [project @ 2006-04-06 08:20:21 by jwe]
jwe
parents: 5307
diff changeset
124 if (instance_ok ())
a527e0f77aa5 [project @ 2006-04-06 08:20:21 by jwe]
jwe
parents: 5307
diff changeset
125 instance->do_clear ();
a527e0f77aa5 [project @ 2006-04-06 08:20:21 by jwe]
jwe
parents: 5307
diff changeset
126 }
a527e0f77aa5 [project @ 2006-04-06 08:20:21 by jwe]
jwe
parents: 5307
diff changeset
127
a527e0f77aa5 [project @ 2006-04-06 08:20:21 by jwe]
jwe
parents: 5307
diff changeset
128 private:
a527e0f77aa5 [project @ 2006-04-06 08:20:21 by jwe]
jwe
parents: 5307
diff changeset
129
a527e0f77aa5 [project @ 2006-04-06 08:20:21 by jwe]
jwe
parents: 5307
diff changeset
130 // The current call stack.
a527e0f77aa5 [project @ 2006-04-06 08:20:21 by jwe]
jwe
parents: 5307
diff changeset
131 std::list<octave_function *> cs;
a527e0f77aa5 [project @ 2006-04-06 08:20:21 by jwe]
jwe
parents: 5307
diff changeset
132
a527e0f77aa5 [project @ 2006-04-06 08:20:21 by jwe]
jwe
parents: 5307
diff changeset
133 static octave_call_stack *instance;
a527e0f77aa5 [project @ 2006-04-06 08:20:21 by jwe]
jwe
parents: 5307
diff changeset
134
a527e0f77aa5 [project @ 2006-04-06 08:20:21 by jwe]
jwe
parents: 5307
diff changeset
135 octave_function *do_current (void) { return cs.empty () ? 0 : cs.front (); }
a527e0f77aa5 [project @ 2006-04-06 08:20:21 by jwe]
jwe
parents: 5307
diff changeset
136
a527e0f77aa5 [project @ 2006-04-06 08:20:21 by jwe]
jwe
parents: 5307
diff changeset
137 octave_function *do_caller (void);
a527e0f77aa5 [project @ 2006-04-06 08:20:21 by jwe]
jwe
parents: 5307
diff changeset
138
a527e0f77aa5 [project @ 2006-04-06 08:20:21 by jwe]
jwe
parents: 5307
diff changeset
139 octave_user_function *do_caller_script (void);
a527e0f77aa5 [project @ 2006-04-06 08:20:21 by jwe]
jwe
parents: 5307
diff changeset
140
a527e0f77aa5 [project @ 2006-04-06 08:20:21 by jwe]
jwe
parents: 5307
diff changeset
141 void do_push (octave_function *f) { cs.push_front (f); }
a527e0f77aa5 [project @ 2006-04-06 08:20:21 by jwe]
jwe
parents: 5307
diff changeset
142
a527e0f77aa5 [project @ 2006-04-06 08:20:21 by jwe]
jwe
parents: 5307
diff changeset
143 void do_pop (void)
a527e0f77aa5 [project @ 2006-04-06 08:20:21 by jwe]
jwe
parents: 5307
diff changeset
144 {
a527e0f77aa5 [project @ 2006-04-06 08:20:21 by jwe]
jwe
parents: 5307
diff changeset
145 if (! cs.empty ())
a527e0f77aa5 [project @ 2006-04-06 08:20:21 by jwe]
jwe
parents: 5307
diff changeset
146 cs.pop_front ();
a527e0f77aa5 [project @ 2006-04-06 08:20:21 by jwe]
jwe
parents: 5307
diff changeset
147 }
a527e0f77aa5 [project @ 2006-04-06 08:20:21 by jwe]
jwe
parents: 5307
diff changeset
148
a527e0f77aa5 [project @ 2006-04-06 08:20:21 by jwe]
jwe
parents: 5307
diff changeset
149 void do_clear (void) { cs.clear (); }
a527e0f77aa5 [project @ 2006-04-06 08:20:21 by jwe]
jwe
parents: 5307
diff changeset
150 };
a527e0f77aa5 [project @ 2006-04-06 08:20:21 by jwe]
jwe
parents: 5307
diff changeset
151
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
152 #endif
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
153
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
154 /*
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
155 ;;; Local Variables: ***
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
156 ;;; mode: C++ ***
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
157 ;;; End: ***
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
158 */