* Apply improved Texinfo markup patch from Dale P. Smith.
[bpt/guile.git] / guile-readline / readline.c
CommitLineData
c374ab69
MV
1/* readline.c --- line editing support for Guile */
2
576cdec4 3/* Copyright (C) 1997,1999, 2000 Free Software Foundation, Inc.
c374ab69
MV
4 *
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2, or (at your option)
8 * any later version.
9 *
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 *
15 * You should have received a copy of the GNU General Public License
16 * along with this software; see the file COPYING. If not, write to
c6e23ea2
JB
17 * the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
18 * Boston, MA 02111-1307 USA
c374ab69
MV
19 *
20 */
f48e47b9
GB
21
22/* Software engineering face-lift by Greg J. Badros, 11-Dec-1999,
23 gjb@cs.washington.edu, http://www.cs.washington.edu/homes/gjb */
24
c374ab69
MV
25\f
26
739b3bf1 27#include "libguile/_scm.h"
62947883 28#ifdef HAVE_RL_GETC_FUNCTION
fbf68f8b 29#include "libguile.h"
739b3bf1
MD
30#include "libguile/gh.h"
31#include "libguile/iselect.h"
32
ffdeebc3 33#include <stdio.h>
48552b1d
MD
34#ifdef HAVE_UNISTD_H
35#include <unistd.h>
36#endif
c374ab69
MV
37#include <readline/readline.h>
38#include <readline/history.h>
c374ab69 39#include <sys/time.h>
b71099ba 40#include <signal.h>
c374ab69 41
1c537018 42#include "libguile/validate.h"
a0599745 43#include "guile-readline/readline.h"
c374ab69
MV
44
45scm_option scm_readline_opts[] = {
46 { SCM_OPTION_BOOLEAN, "history-file", 1,
47 "Use history file." },
48 { SCM_OPTION_INTEGER, "history-length", 200,
49 "History length." },
50 { SCM_OPTION_INTEGER, "bounce-parens", 500,
51 "Time (ms) to show matching opening parenthesis (0 = off)."}
52};
53
54extern void stifle_history (int max);
55
b916d813 56SCM_DEFINE (scm_readline_options, "readline-options-interface", 0, 1, 0,
f48e47b9
GB
57 (SCM setting),
58"")
59#define FUNC_NAME s_scm_readline_options
c374ab69
MV
60{
61 SCM ans = scm_options (setting,
62 scm_readline_opts,
63 SCM_N_READLINE_OPTIONS,
f48e47b9 64 FUNC_NAME);
c374ab69
MV
65 stifle_history (SCM_HISTORY_LENGTH);
66 return ans;
67}
f48e47b9 68#undef FUNC_NAME
c374ab69
MV
69
70#ifndef HAVE_STRDUP
71static char *
72strdup (char *s)
73{
74 int len = strlen (s);
75 char *new = malloc (len + 1);
76 strcpy (new, s);
77 return new;
78}
79#endif /* HAVE_STRDUP */
80
81#ifndef HAVE_RL_CLEANUP_AFTER_SIGNAL
82
83/* These are readline functions added in release 2.3. They will work
84 * together with readline-2.1 and 2.2. (The readline interface is
85 * disabled for earlier releases.)
86 * They are declared static; if we want to use them elsewhere, then
87 * we need external declarations for them, but at the moment, I don't
88 * think anything else in Guile ought to use these.
89 */
90
91extern void _rl_clean_up_for_exit ();
92extern void _rl_kill_kbd_macro ();
93extern int _rl_init_argument ();
94
2e3d5987 95void
c374ab69
MV
96rl_cleanup_after_signal ()
97{
98#ifdef HAVE_RL_CLEAR_SIGNALS
99 _rl_clean_up_for_exit ();
100#endif
101 (*rl_deprep_term_function) ();
102#ifdef HAVE_RL_CLEAR_SIGNALS
103 rl_clear_signals ();
104#endif
105 rl_pending_input = 0;
106}
107
2e3d5987 108void
c374ab69
MV
109rl_free_line_state ()
110{
111 register HIST_ENTRY *entry;
112
113 free_undo_list ();
114
115 entry = current_history ();
116 if (entry)
117 entry->data = (char *)NULL;
118
119 _rl_kill_kbd_macro ();
120 rl_clear_message ();
121 _rl_init_argument ();
122}
123
124#endif /* !HAVE_RL_CLEANUP_AFTER_SIGNAL */
125
126static int promptp;
127static SCM input_port;
128static SCM before_read;
129
130static int
131current_input_getc (FILE *in)
132{
379b35da 133 if (promptp && !SCM_FALSEP (before_read))
c374ab69
MV
134 {
135 scm_apply (before_read, SCM_EOL, SCM_EOL);
136 promptp = 0;
137 }
bc858b80 138 return scm_getc (input_port);
c374ab69
MV
139}
140
141static void
142redisplay ()
143{
144 rl_redisplay ();
145 /* promptp = 1; */
146}
147
c374ab69
MV
148static int in_readline = 0;
149#ifdef USE_THREADS
150static scm_mutex_t reentry_barrier_mutex;
151#endif
152
f48e47b9
GB
153static SCM internal_readline (SCM text);
154static SCM handle_error (void *data, SCM tag, SCM args);
48552b1d 155static void reentry_barrier (void);
f48e47b9
GB
156
157
b916d813 158SCM_DEFINE (scm_readline, "%readline", 0, 4, 0,
f48e47b9
GB
159 (SCM text, SCM inp, SCM outp, SCM read_hook),
160"")
161#define FUNC_NAME s_scm_readline
162{
163 SCM ans;
164
165 reentry_barrier ();
166
167 before_read = SCM_BOOL_F;
168
169 if (!SCM_UNBNDP (text))
170 {
379b35da 171 if (!SCM_STRINGP (text))
f48e47b9
GB
172 {
173 --in_readline;
174 scm_wrong_type_arg (s_scm_readline, SCM_ARG1, text);
175 }
08b5e6c3 176 SCM_STRING_COERCE_0TERMINATION_X (text);
f48e47b9
GB
177 }
178
379b35da
DH
179 if (!((SCM_UNBNDP (inp) && SCM_OPINFPORTP (scm_cur_inp))
180 || SCM_OPINFPORTP (inp)))
f48e47b9
GB
181 {
182 --in_readline;
183 scm_misc_error (s_scm_readline,
184 "Input port is not open or not a file port",
185 SCM_EOL);
186 }
187
379b35da
DH
188 if (!((SCM_UNBNDP (outp) && SCM_OPINFPORTP (scm_cur_outp))
189 || SCM_OPOUTFPORTP (outp)))
f48e47b9
GB
190 {
191 --in_readline;
192 scm_misc_error (s_scm_readline,
193 "Output port is not open or not a file port",
194 SCM_EOL);
195 }
196
197 if (!(SCM_UNBNDP (read_hook) || SCM_FALSEP (read_hook)))
198 {
199 if (!(SCM_NFALSEP (scm_thunk_p (read_hook))))
200 {
201 --in_readline;
202 scm_wrong_type_arg (s_scm_readline, SCM_ARG4, read_hook);
203 }
204 before_read = read_hook;
205 }
206
207 scm_readline_init_ports (inp, outp);
208
209 ans = scm_internal_catch (SCM_BOOL_T,
210 (scm_catch_body_t) internal_readline,
f60d011a 211 (void *) SCM_UNPACK (text),
f48e47b9
GB
212 handle_error, 0);
213
214 fclose (rl_instream);
215 fclose (rl_outstream);
216
217 --in_readline;
218 return ans;
219}
220#undef FUNC_NAME
221
222
c374ab69
MV
223static void
224reentry_barrier ()
225{
226 int reentryp = 0;
227#ifdef USE_THREADS
228 /* We should rather use scm_mutex_try_lock when it becomes available */
229 scm_mutex_lock (&reentry_barrier_mutex);
230#endif
231 if (in_readline)
232 reentryp = 1;
233 else
234 ++in_readline;
235#ifdef USE_THREADS
236 scm_mutex_unlock (&reentry_barrier_mutex);
237#endif
238 if (reentryp)
f48e47b9 239 scm_misc_error (s_scm_readline, "readline is not reentrant", SCM_EOL);
c374ab69
MV
240}
241
242static SCM
243handle_error (void *data, SCM tag, SCM args)
244{
245 rl_free_line_state ();
246 rl_cleanup_after_signal ();
739b3bf1 247 fputc ('\n', rl_outstream); /* We don't want next output on this line */
c374ab69
MV
248 fclose (rl_instream);
249 fclose (rl_outstream);
250 --in_readline;
251 scm_handle_by_throw (data, tag, args);
252 return SCM_UNSPECIFIED; /* never reached */
253}
254
255static SCM
256internal_readline (SCM text)
257{
258 SCM ret;
259 char *s;
08b5e6c3 260 char *prompt = SCM_UNBNDP (text) ? "" : SCM_STRING_CHARS (text);
c374ab69
MV
261
262 promptp = 1;
263 s = readline (prompt);
264 if (s)
265 ret = scm_makfrom0str (s);
266 else
267 ret = SCM_EOF_VAL;
268
269 free (s);
270
271 return ret;
272}
273
274static FILE *
275stream_from_fport (SCM port, char *mode, const char *subr)
276{
277 int fd;
278 FILE *f;
279
280 fd = dup (((struct scm_fport *) SCM_STREAM (port))->fdes);
281 if (fd == -1)
282 {
283 --in_readline;
284 scm_syserror (subr);
285 }
286
287 f = fdopen (fd, mode);
288 if (f == NULL)
289 {
290 --in_readline;
291 scm_syserror (subr);
292 }
293
294 return f;
295}
296
2e3d5987
MD
297void
298scm_readline_init_ports (SCM inp, SCM outp)
299{
300 if (SCM_UNBNDP (inp))
301 inp = scm_cur_inp;
302
303 if (SCM_UNBNDP (outp))
304 outp = scm_cur_outp;
305
379b35da 306 if (!SCM_OPINFPORTP (inp)) {
2e3d5987
MD
307 scm_misc_error (0,
308 "Input port is not open or not a file port",
309 SCM_EOL);
310 }
311
379b35da 312 if (!SCM_OPOUTFPORTP (outp)) {
2e3d5987
MD
313 scm_misc_error (0,
314 "Output port is not open or not a file port",
315 SCM_EOL);
316 }
317
318 input_port = inp;
f48e47b9
GB
319 rl_instream = stream_from_fport (inp, "r", s_scm_readline);
320 rl_outstream = stream_from_fport (outp, "w", s_scm_readline);
2e3d5987
MD
321}
322
c374ab69 323
c374ab69 324
b916d813 325SCM_DEFINE (scm_add_history, "add-history", 1, 0, 0,
f48e47b9
GB
326 (SCM text),
327"")
328#define FUNC_NAME s_scm_add_history
c374ab69
MV
329{
330 char* s;
cbaee92a 331 SCM_VALIDATE_STRING (1,text);
08b5e6c3 332 SCM_STRING_COERCE_0TERMINATION_X (text);
c374ab69 333
08b5e6c3 334 s = SCM_STRING_CHARS (text);
c374ab69
MV
335 add_history (strdup (s));
336
337 return SCM_UNSPECIFIED;
338}
f48e47b9 339#undef FUNC_NAME
c374ab69
MV
340
341
b916d813 342SCM_DEFINE (scm_read_history, "read-history", 1, 0, 0,
f48e47b9
GB
343 (SCM file),
344"")
345#define FUNC_NAME s_scm_read_history
c374ab69 346{
cbaee92a 347 SCM_VALIDATE_STRING (1,file);
08b5e6c3 348 return SCM_NEGATE_BOOL (read_history (SCM_STRING_CHARS (file)));
c374ab69 349}
f48e47b9 350#undef FUNC_NAME
c374ab69
MV
351
352
b916d813 353SCM_DEFINE (scm_write_history, "write-history", 1, 0, 0,
f48e47b9
GB
354 (SCM file),
355"")
356#define FUNC_NAME s_scm_write_history
c374ab69 357{
cbaee92a 358 SCM_VALIDATE_STRING (1,file);
08b5e6c3 359 return SCM_NEGATE_BOOL (write_history (SCM_STRING_CHARS (file)));
c374ab69 360}
f48e47b9 361#undef FUNC_NAME
c374ab69
MV
362
363
b916d813 364SCM_DEFINE (scm_filename_completion_function, "filename-completion-function", 2, 0, 0,
f48e47b9
GB
365 (SCM text, SCM continuep),
366"")
367#define FUNC_NAME s_scm_filename_completion_function
c374ab69
MV
368{
369 char *s;
370 SCM ans;
cbaee92a 371 SCM_VALIDATE_STRING (1,text);
08b5e6c3
DH
372 SCM_STRING_COERCE_0TERMINATION_X (text);
373 s = filename_completion_function (SCM_STRING_CHARS (text), SCM_NFALSEP (continuep));
c374ab69
MV
374 ans = scm_makfrom0str (s);
375 free (s);
376 return ans;
377}
f48e47b9 378#undef FUNC_NAME
c374ab69
MV
379
380/*
381 * The following has been modified from code contributed by
382 * Andrew Archibald <aarchiba@undergrad.math.uwaterloo.ca>
383 */
384
385SCM scm_readline_completion_function_var;
386
387static char *
388completion_function (char *text, int continuep)
389{
390 SCM compfunc = SCM_CDR (scm_readline_completion_function_var);
391 SCM res;
392
393 if (SCM_FALSEP (compfunc))
394 return NULL; /* #f => completion disabled */
395 else
396 {
397 SCM t = scm_makfrom0str (text);
398 SCM c = continuep ? SCM_BOOL_T : SCM_BOOL_F;
399 res = scm_apply (compfunc, SCM_LIST2 (t, c), SCM_EOL);
400
401 if (SCM_FALSEP (res))
402 return NULL;
403
379b35da 404 if (!SCM_STRINGP (res))
f48e47b9 405 scm_misc_error (s_scm_readline,
c374ab69
MV
406 "Completion function returned bogus value: %S",
407 SCM_LIST1 (res));
08b5e6c3
DH
408 SCM_STRING_COERCE_0TERMINATION_X (res);
409 return strdup (SCM_STRING_CHARS (res));
c374ab69
MV
410 }
411}
412
413/*Bouncing parenthesis (reimplemented by GH, 11/23/98, since readline is strict gpl)*/
414
576cdec4
MD
415static int match_paren (int x, int k);
416static int find_matching_paren (int k);
417static void init_bouncing_parens ();
c374ab69
MV
418
419static void
576cdec4 420init_bouncing_parens ()
c374ab69 421{
576cdec4
MD
422 if (strncmp (rl_get_keymap_name (rl_get_keymap ()), "vi", 2))
423 {
424 rl_bind_key (')', match_paren);
425 rl_bind_key (']', match_paren);
426 rl_bind_key ('}', match_paren);
427 }
c374ab69
MV
428}
429
430static int
431find_matching_paren(int k)
432{
433 register int i;
434 register char c = 0;
435 int end_parens_found = 0;
436
437 /* Choose the corresponding opening bracket. */
438 if (k == ')') c = '(';
439 else if (k == ']') c = '[';
440 else if (k == '}') c = '{';
441
442 for (i=rl_point-2; i>=0; i--)
443 {
444 /* Is the current character part of a character literal? */
445 if (i - 2 >= 0
446 && rl_line_buffer[i - 1] == '\\'
447 && rl_line_buffer[i - 2] == '#')
448 ;
449 else if (rl_line_buffer[i] == k)
450 end_parens_found++;
451 else if (rl_line_buffer[i] == '"')
452 {
453 /* Skip over a string literal. */
454 for (i--; i >= 0; i--)
455 if (rl_line_buffer[i] == '"'
456 && ! (i - 1 >= 0
457 && rl_line_buffer[i - 1] == '\\'))
458 break;
459 }
460 else if (rl_line_buffer[i] == c)
461 {
576cdec4
MD
462 if (end_parens_found==0)
463 return i;
c374ab69
MV
464 else --end_parens_found;
465 }
466 }
467 return -1;
468}
469
576cdec4
MD
470static int
471match_paren (int x, int k)
c374ab69 472{
bc858b80 473 int tmp, fno;
aba2031a 474 SELECT_TYPE readset;
c374ab69
MV
475 struct timeval timeout;
476
576cdec4 477 rl_insert (x, k);
c374ab69 478 if (!SCM_READLINE_BOUNCE_PARENS)
576cdec4 479 return 0;
c374ab69
MV
480
481 /* Did we just insert a quoted paren? If so, then don't bounce. */
482 if (rl_point - 1 >= 1
483 && rl_line_buffer[rl_point - 2] == '\\')
576cdec4 484 return 0;
c374ab69
MV
485
486 tmp = 1000 * SCM_READLINE_BOUNCE_PARENS;
487 timeout.tv_sec = tmp / 1000000;
488 timeout.tv_usec = tmp % 1000000;
576cdec4 489 FD_ZERO (&readset);
bc858b80
MD
490 fno = fileno (rl_instream);
491 FD_SET (fno, &readset);
c374ab69 492
576cdec4
MD
493 if (rl_point > 1)
494 {
495 tmp = rl_point;
496 rl_point = find_matching_paren (k);
497 if (rl_point > -1)
498 {
499 rl_redisplay ();
bc858b80 500 scm_internal_select (fno + 1, &readset, NULL, NULL, &timeout);
576cdec4
MD
501 }
502 rl_point = tmp;
c374ab69 503 }
576cdec4 504 return 0;
c374ab69
MV
505}
506
b71099ba
MD
507#if defined (HAVE_RL_PRE_INPUT_HOOK) && defined (GUILE_SIGWINCH_SA_RESTART_CLEARED)
508/* Readline disables SA_RESTART on SIGWINCH.
509 * This code turns it back on.
510 */
511static int
512sigwinch_enable_restart (void)
513{
514#ifdef HAVE_SIGINTERRUPT
515 siginterrupt (SIGWINCH, 0);
516#else
517 struct sigaction action;
518
519 sigaction (SIGWINCH, NULL, &action);
520 action.sa_flags |= SA_RESTART;
521 sigaction (SIGWINCH, &action, NULL);
522#endif
523 return 0;
524}
525#endif
526
26047451
MD
527#endif /* HAVE_RL_GETC_FUNCTION */
528
c374ab69
MV
529void
530scm_init_readline ()
531{
62947883 532#ifdef HAVE_RL_GETC_FUNCTION
a0599745 533#include "guile-readline/readline.x"
c374ab69
MV
534 scm_readline_completion_function_var
535 = scm_sysintern ("*readline-completion-function*", SCM_BOOL_F);
536 rl_getc_function = current_input_getc;
537 rl_redisplay_function = redisplay;
538 rl_completion_entry_function = (Function*) completion_function;
539 rl_basic_word_break_characters = "\t\n\"'`;()";
5c11cc9d 540 rl_readline_name = "Guile";
b71099ba
MD
541#if defined (HAVE_RL_PRE_INPUT_HOOK) && defined (GUILE_SIGWINCH_SA_RESTART_CLEARED)
542 rl_pre_input_hook = sigwinch_enable_restart;
543#endif
5c11cc9d 544
c374ab69 545#ifdef USE_THREADS
b74b1a63 546 scm_mutex_init (&reentry_barrier_mutex);
c374ab69
MV
547#endif
548 scm_init_opts (scm_readline_options,
549 scm_readline_opts,
550 SCM_N_READLINE_OPTIONS);
551 init_bouncing_parens();
552 scm_add_feature ("readline");
62947883 553#endif /* HAVE_RL_GETC_FUNCTION */
c374ab69
MV
554}
555
89e00824
ML
556/*
557 Local Variables:
558 c-file-style: "gnu"
559 End:
560*/