|
1
|
1 /* |
|
|
2 |
|
2847
|
3 Copyright (C) 1996, 1997 John W. Eaton |
|
1
|
4 |
|
|
5 This file is part of Octave. |
|
|
6 |
|
|
7 Octave is free software; you can redistribute it and/or modify it |
|
|
8 under the terms of the GNU General Public License as published by the |
|
|
9 Free Software Foundation; either version 2, or (at your option) any |
|
|
10 later version. |
|
|
11 |
|
|
12 Octave is distributed in the hope that it will be useful, but WITHOUT |
|
|
13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
|
|
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
|
|
15 for more details. |
|
|
16 |
|
|
17 You should have received a copy of the GNU General Public License |
|
|
18 along with Octave; see the file COPYING. If not, write to the Free |
|
1315
|
19 Software Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. |
|
1
|
20 |
|
|
21 */ |
|
|
22 |
|
240
|
23 #ifdef HAVE_CONFIG_H |
|
1192
|
24 #include <config.h> |
|
1
|
25 #endif |
|
|
26 |
|
1343
|
27 #include <csignal> |
|
|
28 |
|
3503
|
29 #include <fstream> |
|
1755
|
30 #include <string> |
|
1
|
31 |
|
2926
|
32 #include "cmd-edit.h" |
|
|
33 #include "oct-env.h" |
|
2101
|
34 |
|
1
|
35 #include "procstream.h" |
|
|
36 |
|
2492
|
37 #include <defaults.h> |
|
1352
|
38 #include "defun.h" |
|
|
39 #include "error.h" |
|
2164
|
40 #include "gripes.h" |
|
2110
|
41 #include "input.h" |
|
1755
|
42 #include "oct-obj.h" |
|
1352
|
43 #include "pager.h" |
|
990
|
44 #include "sighandlers.h" |
|
2100
|
45 #include "unwind-prot.h" |
|
2201
|
46 #include "utils.h" |
|
2368
|
47 #include "variables.h" |
|
2093
|
48 |
|
2209
|
49 static pid_t octave_pager_pid = -1; |
|
1
|
50 |
|
2093
|
51 // Our actual connection to the external pager. |
|
|
52 static oprocstream *external_pager = 0; |
|
1
|
53 |
|
3018
|
54 // TRUE means we write to the diary file. |
|
|
55 static bool write_to_diary_file = false; |
|
581
|
56 |
|
|
57 // The name of the current diary file. |
|
3523
|
58 static std::string diary_file; |
|
581
|
59 |
|
|
60 // The diary file. |
|
3523
|
61 static std::ofstream external_diary_file; |
|
581
|
62 |
|
2164
|
63 // The shell command to run as the pager. |
|
3523
|
64 static std::string Vpager_binary; |
|
2164
|
65 |
|
|
66 // TRUE means that if output is going to the pager, it is sent as soon |
|
|
67 // as it is available. Otherwise, it is buffered and only sent to the |
|
|
68 // pager when it is time to print another prompt. |
|
|
69 static bool Vpage_output_immediately; |
|
|
70 |
|
|
71 // TRUE means all output intended for the screen should be passed |
|
|
72 // through the pager. |
|
|
73 static bool Vpage_screen_output; |
|
|
74 |
|
2705
|
75 // Only one pager can be active at once, so having these at file |
|
|
76 // scope should be ok. |
|
|
77 static octave_interrupt_handler saved_interrupt_handler; |
|
|
78 static bool interrupt_handler_saved = false; |
|
2093
|
79 |
|
3018
|
80 static bool really_flush_to_pager = false; |
|
2100
|
81 |
|
3018
|
82 static bool flushing_output_to_pager = false; |
|
2206
|
83 |
|
2093
|
84 static void |
|
2197
|
85 clear_external_pager (void) |
|
|
86 { |
|
2210
|
87 octave_child_list::remove (octave_pager_pid); |
|
|
88 |
|
2197
|
89 octave_pager_pid = -1; |
|
|
90 |
|
|
91 delete external_pager; |
|
|
92 external_pager = 0; |
|
|
93 |
|
2705
|
94 if (interrupt_handler_saved) |
|
2197
|
95 { |
|
2554
|
96 octave_set_interrupt_handler (saved_interrupt_handler); |
|
2705
|
97 interrupt_handler_saved = false; |
|
2197
|
98 } |
|
|
99 } |
|
|
100 |
|
|
101 static void |
|
2209
|
102 pager_death_handler (pid_t pid, int status) |
|
|
103 { |
|
|
104 if (pid > 0) |
|
|
105 { |
|
|
106 if (WIFEXITED (status) || WIFSIGNALLED (status)) |
|
|
107 { |
|
2795
|
108 // Avoid warning() or error(), since that will put us back in |
|
|
109 // the pager, which would be bad news. |
|
2209
|
110 |
|
3531
|
111 std::cerr << "warning: connection to external pager (pid = " |
|
2795
|
112 << pid << ") lost --\n" |
|
|
113 << "warning: attempting to finish pending computations...\n"; |
|
2209
|
114 } |
|
|
115 } |
|
|
116 } |
|
|
117 |
|
|
118 static void |
|
3233
|
119 do_sync (const char *msg, int len, bool bypass_pager) |
|
1
|
120 { |
|
3233
|
121 if (msg && len > 0) |
|
1
|
122 { |
|
2206
|
123 if (bypass_pager) |
|
2646
|
124 { |
|
3531
|
125 std::cout.write (msg, len); |
|
|
126 std::cout.flush (); |
|
2646
|
127 } |
|
2206
|
128 else |
|
2093
|
129 { |
|
2206
|
130 if (! external_pager) |
|
2093
|
131 { |
|
3523
|
132 std::string pgr = Vpager_binary; |
|
2093
|
133 |
|
2206
|
134 if (! pgr.empty ()) |
|
|
135 { |
|
2554
|
136 saved_interrupt_handler = octave_ignore_interrupts (); |
|
2705
|
137 interrupt_handler_saved = true; |
|
2093
|
138 |
|
2206
|
139 external_pager = new oprocstream (pgr.c_str ()); |
|
2093
|
140 |
|
2206
|
141 if (external_pager) |
|
2209
|
142 { |
|
|
143 octave_pager_pid = external_pager->pid (); |
|
|
144 |
|
|
145 octave_child_list::insert (octave_pager_pid, |
|
|
146 pager_death_handler); |
|
|
147 } |
|
2093
|
148 } |
|
2206
|
149 } |
|
2101
|
150 |
|
2206
|
151 if (external_pager) |
|
|
152 { |
|
|
153 if (octave_pager_pid > 0 && external_pager->good ()) |
|
2101
|
154 { |
|
3233
|
155 external_pager->write (msg, len); |
|
2101
|
156 |
|
2206
|
157 // These checks are needed if a signal handler |
|
|
158 // invoked since the last set of checks attempts |
|
|
159 // to flush output and then returns |
|
2197
|
160 |
|
2206
|
161 if (octave_pager_pid > 0 |
|
|
162 && external_pager |
|
|
163 && external_pager->good ()) |
|
|
164 external_pager->flush (); |
|
2101
|
165 } |
|
2795
|
166 else |
|
|
167 { |
|
|
168 // We had a pager, but it must have died. Restore |
|
|
169 // the interrupt state so we can escape back to the |
|
|
170 // prompt if there are lots of computations pending. |
|
|
171 |
|
|
172 if (interrupt_handler_saved) |
|
|
173 { |
|
|
174 octave_set_interrupt_handler (saved_interrupt_handler); |
|
|
175 interrupt_handler_saved = false; |
|
|
176 } |
|
|
177 } |
|
2093
|
178 } |
|
2206
|
179 else |
|
2646
|
180 { |
|
3531
|
181 std::cout.write (msg, len); |
|
|
182 std::cout.flush (); |
|
2646
|
183 } |
|
2093
|
184 } |
|
1
|
185 } |
|
|
186 } |
|
|
187 |
|
3233
|
188 // Assume our terminal wraps long lines. |
|
|
189 |
|
2101
|
190 static bool |
|
3233
|
191 more_than_a_screenful (const char *s, int len) |
|
2101
|
192 { |
|
|
193 if (s) |
|
|
194 { |
|
2926
|
195 int available_rows = command_editor::terminal_rows () - 2; |
|
2101
|
196 |
|
3233
|
197 int cols = command_editor::terminal_cols (); |
|
|
198 |
|
2103
|
199 int count = 0; |
|
|
200 |
|
3233
|
201 int chars_this_line = 0; |
|
2101
|
202 |
|
3233
|
203 for (int i = 0; i < len; i++) |
|
|
204 { |
|
|
205 if (*s++ == '\n') |
|
|
206 { |
|
|
207 count += chars_this_line / cols + 1; |
|
|
208 chars_this_line = 0; |
|
|
209 } |
|
|
210 else |
|
|
211 chars_this_line++; |
|
|
212 } |
|
2101
|
213 |
|
3233
|
214 if (count > available_rows) |
|
|
215 return true; |
|
2101
|
216 } |
|
|
217 |
|
|
218 return false; |
|
|
219 } |
|
|
220 |
|
2093
|
221 int |
|
|
222 octave_pager_buf::sync (void) |
|
|
223 { |
|
2186
|
224 if (! interactive |
|
|
225 || really_flush_to_pager |
|
2164
|
226 || (Vpage_screen_output && Vpage_output_immediately) |
|
|
227 || ! Vpage_screen_output) |
|
2100
|
228 { |
|
3233
|
229 char *buf = eback (); |
|
2093
|
230 |
|
3233
|
231 int len = pptr () - buf; |
|
2100
|
232 |
|
2110
|
233 bool bypass_pager = (! interactive |
|
2164
|
234 || ! Vpage_screen_output |
|
2110
|
235 || (really_flush_to_pager |
|
2164
|
236 && Vpage_screen_output |
|
|
237 && ! Vpage_output_immediately |
|
3233
|
238 && ! more_than_a_screenful (buf, len))); |
|
2475
|
239 |
|
3233
|
240 if (len > 0) |
|
|
241 { |
|
|
242 do_sync (buf, len, bypass_pager); |
|
2093
|
243 |
|
3544
|
244 seekoff (0, std::ios::beg); |
|
3233
|
245 |
|
|
246 octave_diary.write (buf, len); |
|
|
247 } |
|
2100
|
248 } |
|
2093
|
249 |
|
|
250 return 0; |
|
|
251 } |
|
|
252 |
|
3477
|
253 void |
|
|
254 octave_pager_buf::flush_current_contents_to_diary (void) |
|
|
255 { |
|
|
256 char *buf = eback (); |
|
|
257 |
|
|
258 int len = pptr () - buf; |
|
|
259 |
|
|
260 octave_diary.write (buf, len); |
|
|
261 } |
|
|
262 |
|
2093
|
263 int |
|
|
264 octave_diary_buf::sync (void) |
|
|
265 { |
|
3233
|
266 if (write_to_diary_file && external_diary_file) |
|
|
267 { |
|
|
268 int len = pptr () - eback (); |
|
2093
|
269 |
|
3233
|
270 if (len > 0) |
|
|
271 external_diary_file.write (eback (), len); |
|
|
272 } |
|
2093
|
273 |
|
3544
|
274 seekoff (0, std::ios::beg); |
|
2093
|
275 |
|
|
276 return 0; |
|
|
277 } |
|
|
278 |
|
|
279 octave_pager_stream *octave_pager_stream::instance = 0; |
|
|
280 |
|
3523
|
281 octave_pager_stream::octave_pager_stream (void) : std::ostream (), pb (0) |
|
1
|
282 { |
|
2093
|
283 pb = new octave_pager_buf; |
|
|
284 rdbuf (pb); |
|
|
285 setf (unitbuf); |
|
|
286 } |
|
|
287 |
|
|
288 octave_pager_stream::~octave_pager_stream (void) |
|
|
289 { |
|
|
290 flush (); |
|
|
291 delete pb; |
|
|
292 } |
|
|
293 |
|
|
294 octave_pager_stream& |
|
|
295 octave_pager_stream::stream (void) |
|
|
296 { |
|
|
297 if (! instance) |
|
|
298 instance = new octave_pager_stream (); |
|
2926
|
299 |
|
2093
|
300 return *instance; |
|
|
301 } |
|
|
302 |
|
3477
|
303 void |
|
|
304 octave_pager_stream::flush_current_contents_to_diary (void) |
|
|
305 { |
|
|
306 if (pb) |
|
|
307 pb->flush_current_contents_to_diary (); |
|
|
308 } |
|
|
309 |
|
2093
|
310 octave_diary_stream *octave_diary_stream::instance = 0; |
|
|
311 |
|
3523
|
312 octave_diary_stream::octave_diary_stream (void) : std::ostream (), db (0) |
|
2093
|
313 { |
|
|
314 db = new octave_diary_buf; |
|
|
315 rdbuf (db); |
|
|
316 setf (unitbuf); |
|
|
317 } |
|
|
318 |
|
|
319 octave_diary_stream::~octave_diary_stream (void) |
|
|
320 { |
|
|
321 flush (); |
|
|
322 delete db; |
|
|
323 } |
|
|
324 |
|
|
325 octave_diary_stream& |
|
|
326 octave_diary_stream::stream (void) |
|
|
327 { |
|
|
328 if (! instance) |
|
|
329 instance = new octave_diary_stream (); |
|
|
330 |
|
|
331 return *instance; |
|
1
|
332 } |
|
|
333 |
|
|
334 void |
|
2093
|
335 flush_octave_stdout (void) |
|
1
|
336 { |
|
2206
|
337 if (! flushing_output_to_pager) |
|
|
338 { |
|
2985
|
339 unwind_protect::begin_frame ("flush_octave_stdout"); |
|
2100
|
340 |
|
3018
|
341 unwind_protect_bool (really_flush_to_pager); |
|
|
342 unwind_protect_bool (flushing_output_to_pager); |
|
2100
|
343 |
|
3018
|
344 really_flush_to_pager = true; |
|
|
345 flushing_output_to_pager = true; |
|
2206
|
346 |
|
|
347 octave_stdout.flush (); |
|
1
|
348 |
|
2206
|
349 if (external_pager) |
|
|
350 clear_external_pager (); |
|
2100
|
351 |
|
2985
|
352 unwind_protect::run_frame ("flush_octave_stdout"); |
|
2206
|
353 } |
|
1
|
354 } |
|
|
355 |
|
1965
|
356 static void |
|
2093
|
357 close_diary_file (void) |
|
1
|
358 { |
|
3477
|
359 // Try to flush the current buffer to the diary now, so that things |
|
|
360 // like |
|
|
361 // |
|
|
362 // function foo () |
|
|
363 // diary on; |
|
|
364 // ... |
|
|
365 // diary off; |
|
|
366 // endfunction |
|
|
367 // |
|
|
368 // will do the right thing. |
|
|
369 |
|
|
370 octave_stdout.flush_current_contents_to_diary (); |
|
|
371 |
|
2093
|
372 if (external_diary_file.is_open ()) |
|
1
|
373 { |
|
2093
|
374 octave_diary.flush (); |
|
|
375 external_diary_file.close (); |
|
1
|
376 } |
|
|
377 } |
|
|
378 |
|
581
|
379 static void |
|
|
380 open_diary_file (void) |
|
|
381 { |
|
2093
|
382 close_diary_file (); |
|
581
|
383 |
|
3544
|
384 external_diary_file.open (diary_file.c_str (), std::ios::app); |
|
581
|
385 |
|
2093
|
386 if (! external_diary_file) |
|
|
387 error ("diary: can't open diary file `%s'", diary_file.c_str ()); |
|
581
|
388 } |
|
|
389 |
|
1957
|
390 DEFUN_TEXT (diary, args, , |
|
3332
|
391 "-*- texinfo -*-\n\ |
|
|
392 @deffn {Command} diary options\n\ |
|
|
393 Create a list of all commands @emph{and} the output they produce, mixed\n\ |
|
|
394 together just as you see them on your terminal. Valid options are:\n\ |
|
|
395 \n\ |
|
|
396 @table @code\n\ |
|
|
397 @item on\n\ |
|
|
398 Start recording your session in a file called @file{diary} in your\n\ |
|
|
399 current working directory.\n\ |
|
581
|
400 \n\ |
|
3332
|
401 @item off\n\ |
|
|
402 Stop recording your session in the diary file.\n\ |
|
|
403 \n\ |
|
|
404 @item @var{file}\n\ |
|
|
405 Record your session in the file named @var{file}.\n\ |
|
|
406 @end table\n\ |
|
|
407 \n\ |
|
|
408 Without any arguments, @code{diary} toggles the current diary state.\n\ |
|
3333
|
409 @end deffn") |
|
581
|
410 { |
|
2086
|
411 octave_value_list retval; |
|
581
|
412 |
|
1755
|
413 int argc = args.length () + 1; |
|
|
414 |
|
1965
|
415 string_vector argv = args.make_argv ("diary"); |
|
581
|
416 |
|
1755
|
417 if (error_state) |
|
|
418 return retval; |
|
|
419 |
|
|
420 if (diary_file.empty ()) |
|
|
421 diary_file = "diary"; |
|
1306
|
422 |
|
581
|
423 switch (argc) |
|
|
424 { |
|
|
425 case 1: |
|
|
426 write_to_diary_file = ! write_to_diary_file; |
|
|
427 open_diary_file (); |
|
|
428 break; |
|
623
|
429 |
|
581
|
430 case 2: |
|
|
431 { |
|
3523
|
432 std::string arg = argv[1]; |
|
1755
|
433 |
|
|
434 if (arg == "on") |
|
581
|
435 { |
|
3018
|
436 write_to_diary_file = true; |
|
581
|
437 open_diary_file (); |
|
|
438 } |
|
1755
|
439 else if (arg == "off") |
|
2093
|
440 { |
|
|
441 close_diary_file (); |
|
3018
|
442 write_to_diary_file = false; |
|
2093
|
443 } |
|
581
|
444 else |
|
|
445 { |
|
1755
|
446 diary_file = arg; |
|
3176
|
447 write_to_diary_file = true; |
|
581
|
448 open_diary_file (); |
|
|
449 } |
|
|
450 } |
|
|
451 break; |
|
777
|
452 |
|
581
|
453 default: |
|
|
454 print_usage ("diary"); |
|
|
455 break; |
|
|
456 } |
|
|
457 |
|
|
458 return retval; |
|
|
459 } |
|
|
460 |
|
1957
|
461 DEFUN_TEXT (more, args, , |
|
3372
|
462 "-*- texinfo -*-\n\ |
|
|
463 @deffn {Command} more\n\ |
|
|
464 @deffnx {Command} more on\n\ |
|
|
465 @deffnx {Command} more off\n\ |
|
|
466 Turn output pagination on or off. Without an argument, @code{more}\n\ |
|
|
467 toggles the current state.\n\ |
|
|
468 @end deffn") |
|
1409
|
469 { |
|
2086
|
470 octave_value_list retval; |
|
1409
|
471 |
|
1755
|
472 int argc = args.length () + 1; |
|
|
473 |
|
1965
|
474 string_vector argv = args.make_argv ("more"); |
|
1755
|
475 |
|
|
476 if (error_state) |
|
|
477 return retval; |
|
1409
|
478 |
|
|
479 if (argc == 2) |
|
|
480 { |
|
3523
|
481 std::string arg = argv[1]; |
|
1409
|
482 |
|
1755
|
483 if (arg == "on") |
|
2448
|
484 bind_builtin_variable ("page_screen_output", 1.0); |
|
1755
|
485 else if (arg == "off") |
|
2448
|
486 bind_builtin_variable ("page_screen_output", 0.0); |
|
1409
|
487 else |
|
1755
|
488 error ("more: unrecognized argument `%s'", arg.c_str ()); |
|
1409
|
489 } |
|
|
490 else |
|
|
491 print_usage ("more"); |
|
|
492 |
|
|
493 return retval; |
|
|
494 } |
|
|
495 |
|
3536
|
496 static std::string |
|
2097
|
497 default_pager (void) |
|
|
498 { |
|
3523
|
499 std::string pager_binary = octave_env::getenv ("PAGER"); |
|
2097
|
500 |
|
|
501 #ifdef DEFAULT_PAGER |
|
2926
|
502 if (pager_binary.empty ()) |
|
2097
|
503 { |
|
3523
|
504 pager_binary = std::string (DEFAULT_PAGER); |
|
2097
|
505 |
|
|
506 if (pager_binary == "less") |
|
|
507 { |
|
|
508 pager_binary.append (" -e"); |
|
|
509 |
|
3523
|
510 std::string lessflags = octave_env::getenv ("LESS"); |
|
2926
|
511 if (lessflags.empty ()) |
|
2097
|
512 pager_binary.append |
|
2099
|
513 (" -P'-- less ?pB(%pB\\%):--. (f)orward, (b)ack, (q)uit$'"); |
|
2097
|
514 } |
|
|
515 } |
|
|
516 #endif |
|
|
517 |
|
|
518 return pager_binary; |
|
|
519 } |
|
|
520 |
|
2164
|
521 static int |
|
|
522 pager_binary (void) |
|
|
523 { |
|
|
524 int status = 0; |
|
|
525 |
|
3523
|
526 std::string s = builtin_string_variable ("PAGER"); |
|
2164
|
527 |
|
|
528 if (s.empty ()) |
|
|
529 { |
|
|
530 gripe_invalid_value_specified ("PAGER"); |
|
|
531 status = -1; |
|
|
532 } |
|
|
533 else |
|
|
534 Vpager_binary = s; |
|
|
535 |
|
|
536 return status; |
|
|
537 } |
|
|
538 |
|
|
539 static int |
|
|
540 page_output_immediately (void) |
|
|
541 { |
|
|
542 Vpage_output_immediately = check_preference ("page_output_immediately"); |
|
|
543 |
|
|
544 return 0; |
|
|
545 } |
|
|
546 |
|
|
547 static int |
|
|
548 page_screen_output (void) |
|
|
549 { |
|
|
550 Vpage_screen_output = check_preference ("page_screen_output"); |
|
|
551 |
|
|
552 return 0; |
|
|
553 } |
|
|
554 |
|
2097
|
555 void |
|
|
556 symbols_of_pager (void) |
|
|
557 { |
|
3258
|
558 DEFVAR (PAGER, default_pager (), pager_binary, |
|
3372
|
559 "-*- texinfo -*-\n\ |
|
|
560 @defvr {Built-in Variable} PAGER\n\ |
|
|
561 The default value is normally @code{\"less\"}, @code{\"more\"}, or\n\ |
|
|
562 @code{\"pg\"}, depending on what programs are installed on your system.\n\ |
|
|
563 @xref{Installation}.\n\ |
|
|
564 \n\ |
|
|
565 When running interactively, Octave sends any output intended for your\n\ |
|
|
566 terminal that is more than one screen long to the program named by the\n\ |
|
|
567 value of the variable @code{PAGER}.\n\ |
|
|
568 @end defvr"); |
|
2097
|
569 |
|
3258
|
570 DEFVAR (page_output_immediately, 0.0, page_output_immediately, |
|
3372
|
571 "-*- texinfo -*-\n\ |
|
|
572 @defvr {Built-in Variable} page_output_immediately\n\ |
|
|
573 If the value of @code{page_output_immediately} is nonzero, Octave sends\n\ |
|
|
574 output to the pager as soon as it is available. Otherwise, Octave\n\ |
|
|
575 buffers its output and waits until just before the prompt is printed to\n\ |
|
|
576 flush it to the pager. The default value is 0.\n\ |
|
|
577 @end defvr"); |
|
2100
|
578 |
|
3258
|
579 DEFVAR (page_screen_output, 1.0, page_screen_output, |
|
3372
|
580 "-*- texinfo -*-\n\ |
|
|
581 @defvr {Built-in Variable} page_screen_output\n\ |
|
|
582 If the value of @code{page_screen_output} is nonzero, all output\n\ |
|
|
583 intended for the screen that is longer than one page is sent through a\n\ |
|
|
584 pager. This allows you to view one screenful at a time. Some pagers\n\ |
|
|
585 (such as @code{less}---see @ref{Installation}) are also capable of moving\n\ |
|
|
586 backward on the output. The default value is 1.\n\ |
|
|
587 @end defvr"); |
|
2097
|
588 } |
|
|
589 |
|
1
|
590 /* |
|
|
591 ;;; Local Variables: *** |
|
|
592 ;;; mode: C++ *** |
|
|
593 ;;; End: *** |
|
|
594 */ |
