add #:resolve-syntax-parameters? kwarg to syntax-local-binding
[bpt/guile.git] / guile-readline / readline.c
CommitLineData
c374ab69
MV
1/* readline.c --- line editing support for Guile */
2
08467a7e 3/* Copyright (C) 1997,1999,2000,2001, 2002, 2003, 2006, 2007, 2008, 2009, 2010, 2013 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
b82a8b48 7 * the Free Software Foundation; either version 3, or (at your option)
c374ab69
MV
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
92205699
MV
17 * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
18 * Boston, MA 02110-1301 USA
c374ab69
MV
19 *
20 */
f48e47b9 21
f48e47b9 22
c374ab69 23\f
7a5ab369
LC
24#ifdef HAVE_CONFIG_H
25# include <config.h>
26#endif
26aff4f9 27
62947883 28#ifdef HAVE_RL_GETC_FUNCTION
fbf68f8b 29#include "libguile.h"
739b3bf1
MD
30#include "libguile/iselect.h"
31
ffdeebc3 32#include <stdio.h>
48552b1d
MD
33#ifdef HAVE_UNISTD_H
34#include <unistd.h>
35#endif
c374ab69
MV
36#include <readline/readline.h>
37#include <readline/history.h>
5e90b6ac 38#ifndef __MINGW32__
c374ab69 39#include <sys/time.h>
5e90b6ac
MV
40#else
41#include <io.h>
42#endif
b71099ba 43#include <signal.h>
c374ab69 44
1c537018 45#include "libguile/validate.h"
a0599745 46#include "guile-readline/readline.h"
c374ab69 47
593be5d2 48scm_t_option scm_readline_opts[] = {
c374ab69
MV
49 { SCM_OPTION_BOOLEAN, "history-file", 1,
50 "Use history file." },
51 { SCM_OPTION_INTEGER, "history-length", 200,
52 "History length." },
53 { SCM_OPTION_INTEGER, "bounce-parens", 500,
62560650
HWN
54 "Time (ms) to show matching opening parenthesis (0 = off)."},
55 { 0 }
c374ab69
MV
56};
57
58extern void stifle_history (int max);
59
b916d813 60SCM_DEFINE (scm_readline_options, "readline-options-interface", 0, 1, 0,
f48e47b9
GB
61 (SCM setting),
62"")
63#define FUNC_NAME s_scm_readline_options
c374ab69
MV
64{
65 SCM ans = scm_options (setting,
66 scm_readline_opts,
f48e47b9 67 FUNC_NAME);
c374ab69
MV
68 stifle_history (SCM_HISTORY_LENGTH);
69 return ans;
70}
f48e47b9 71#undef FUNC_NAME
c374ab69
MV
72
73#ifndef HAVE_STRDUP
74static char *
75strdup (char *s)
76{
1be6b49c 77 size_t len = strlen (s);
c374ab69
MV
78 char *new = malloc (len + 1);
79 strcpy (new, s);
80 return new;
81}
82#endif /* HAVE_STRDUP */
83
84#ifndef HAVE_RL_CLEANUP_AFTER_SIGNAL
85
86/* These are readline functions added in release 2.3. They will work
87 * together with readline-2.1 and 2.2. (The readline interface is
88 * disabled for earlier releases.)
89 * They are declared static; if we want to use them elsewhere, then
90 * we need external declarations for them, but at the moment, I don't
91 * think anything else in Guile ought to use these.
92 */
93
94extern void _rl_clean_up_for_exit ();
95extern void _rl_kill_kbd_macro ();
96extern int _rl_init_argument ();
97
2e3d5987 98void
c374ab69
MV
99rl_cleanup_after_signal ()
100{
101#ifdef HAVE_RL_CLEAR_SIGNALS
102 _rl_clean_up_for_exit ();
103#endif
104 (*rl_deprep_term_function) ();
105#ifdef HAVE_RL_CLEAR_SIGNALS
106 rl_clear_signals ();
107#endif
108 rl_pending_input = 0;
109}
110
2e3d5987 111void
c374ab69
MV
112rl_free_line_state ()
113{
114 register HIST_ENTRY *entry;
115
116 free_undo_list ();
117
118 entry = current_history ();
119 if (entry)
120 entry->data = (char *)NULL;
121
122 _rl_kill_kbd_macro ();
123 rl_clear_message ();
124 _rl_init_argument ();
125}
126
127#endif /* !HAVE_RL_CLEANUP_AFTER_SIGNAL */
128
129static int promptp;
130static SCM input_port;
75192345 131static SCM output_port;
c374ab69
MV
132static SCM before_read;
133
134static int
e81d98ec 135current_input_getc (FILE *in SCM_UNUSED)
c374ab69 136{
be49d1df 137 if (promptp && scm_is_true (before_read))
c374ab69
MV
138 {
139 scm_apply (before_read, SCM_EOL, SCM_EOL);
140 promptp = 0;
141 }
75192345 142 return scm_get_byte_or_eof (input_port);
c374ab69
MV
143}
144
c374ab69 145static int in_readline = 0;
bb0f37e7 146static SCM reentry_barrier_mutex;
c374ab69 147
f48e47b9 148static SCM internal_readline (SCM text);
ddfb5e2b 149static void unwind_readline (void *unused);
48552b1d 150static void reentry_barrier (void);
f48e47b9
GB
151
152
b916d813 153SCM_DEFINE (scm_readline, "%readline", 0, 4, 0,
f48e47b9
GB
154 (SCM text, SCM inp, SCM outp, SCM read_hook),
155"")
156#define FUNC_NAME s_scm_readline
157{
158 SCM ans;
159
160 reentry_barrier ();
161
162 before_read = SCM_BOOL_F;
163
164 if (!SCM_UNBNDP (text))
165 {
ad6dec05 166 if (!scm_is_string (text))
f48e47b9
GB
167 {
168 --in_readline;
169 scm_wrong_type_arg (s_scm_readline, SCM_ARG1, text);
170 }
f48e47b9
GB
171 }
172
0ddf47fc 173 if (!((SCM_UNBNDP (inp) && SCM_OPINFPORTP (scm_current_input_port ()))
379b35da 174 || SCM_OPINFPORTP (inp)))
f48e47b9
GB
175 {
176 --in_readline;
177 scm_misc_error (s_scm_readline,
178 "Input port is not open or not a file port",
179 SCM_EOL);
180 }
181
0ddf47fc 182 if (!((SCM_UNBNDP (outp) && SCM_OPOUTFPORTP (scm_current_output_port ()))
379b35da 183 || SCM_OPOUTFPORTP (outp)))
f48e47b9
GB
184 {
185 --in_readline;
186 scm_misc_error (s_scm_readline,
187 "Output port is not open or not a file port",
188 SCM_EOL);
189 }
190
be49d1df 191 if (!(SCM_UNBNDP (read_hook) || scm_is_false (read_hook)))
f48e47b9 192 {
be49d1df 193 if (scm_is_false (scm_thunk_p (read_hook)))
f48e47b9
GB
194 {
195 --in_readline;
196 scm_wrong_type_arg (s_scm_readline, SCM_ARG4, read_hook);
197 }
198 before_read = read_hook;
199 }
200
201 scm_readline_init_ports (inp, outp);
202
ddfb5e2b
AW
203 scm_dynwind_begin (0);
204 scm_dynwind_unwind_handler (unwind_readline, NULL, 0);
205
206 ans = internal_readline (text);
207
208 scm_dynwind_end ();
f48e47b9 209
8f99e3f3 210#ifndef __MINGW32__
f48e47b9
GB
211 fclose (rl_instream);
212 fclose (rl_outstream);
8f99e3f3 213#endif
f48e47b9
GB
214
215 --in_readline;
216 return ans;
217}
218#undef FUNC_NAME
219
220
c374ab69
MV
221static void
222reentry_barrier ()
223{
224 int reentryp = 0;
246c563b 225 /* We should rather use scm_try_mutex when it becomes available */
bb0f37e7 226 scm_lock_mutex (reentry_barrier_mutex);
c374ab69
MV
227 if (in_readline)
228 reentryp = 1;
229 else
230 ++in_readline;
bb0f37e7 231 scm_unlock_mutex (reentry_barrier_mutex);
c374ab69 232 if (reentryp)
f48e47b9 233 scm_misc_error (s_scm_readline, "readline is not reentrant", SCM_EOL);
c374ab69
MV
234}
235
ddfb5e2b
AW
236/* This function is only called on nonlocal exit from readline(). */
237static void
238unwind_readline (void *unused)
c374ab69
MV
239{
240 rl_free_line_state ();
241 rl_cleanup_after_signal ();
739b3bf1 242 fputc ('\n', rl_outstream); /* We don't want next output on this line */
8f99e3f3 243#ifndef __MINGW32__
c374ab69
MV
244 fclose (rl_instream);
245 fclose (rl_outstream);
8f99e3f3 246#endif
c374ab69 247 --in_readline;
c374ab69
MV
248}
249
250static SCM
251internal_readline (SCM text)
252{
253 SCM ret;
254 char *s;
ad6dec05 255 char *prompt = SCM_UNBNDP (text) ? "" : scm_to_locale_string (text);
c374ab69
MV
256
257 promptp = 1;
258 s = readline (prompt);
259 if (s)
08467a7e 260 ret = scm_from_port_string (s, output_port);
c374ab69
MV
261 else
262 ret = SCM_EOF_VAL;
263
ad6dec05
MV
264 if (!SCM_UNBNDP (text))
265 free (prompt);
c374ab69
MV
266 free (s);
267
268 return ret;
269}
270
271static FILE *
272stream_from_fport (SCM port, char *mode, const char *subr)
273{
274 int fd;
275 FILE *f;
276
593be5d2 277 fd = dup (((struct scm_t_fport *) SCM_STREAM (port))->fdes);
c374ab69
MV
278 if (fd == -1)
279 {
280 --in_readline;
281 scm_syserror (subr);
282 }
283
284 f = fdopen (fd, mode);
285 if (f == NULL)
286 {
287 --in_readline;
288 scm_syserror (subr);
289 }
290
291 return f;
292}
293
2e3d5987
MD
294void
295scm_readline_init_ports (SCM inp, SCM outp)
296{
297 if (SCM_UNBNDP (inp))
0ddf47fc 298 inp = scm_current_input_port ();
2e3d5987
MD
299
300 if (SCM_UNBNDP (outp))
0ddf47fc 301 outp = scm_current_output_port ();
2e3d5987 302
379b35da 303 if (!SCM_OPINFPORTP (inp)) {
2e3d5987
MD
304 scm_misc_error (0,
305 "Input port is not open or not a file port",
306 SCM_EOL);
307 }
308
379b35da 309 if (!SCM_OPOUTFPORTP (outp)) {
2e3d5987
MD
310 scm_misc_error (0,
311 "Output port is not open or not a file port",
312 SCM_EOL);
313 }
314
315 input_port = inp;
75192345 316 output_port = outp;
8f99e3f3 317#ifndef __MINGW32__
f48e47b9
GB
318 rl_instream = stream_from_fport (inp, "r", s_scm_readline);
319 rl_outstream = stream_from_fport (outp, "w", s_scm_readline);
8f99e3f3 320#endif
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;
c374ab69 331
ad6dec05
MV
332 s = scm_to_locale_string (text);
333 add_history (s);
d3075c52 334 free (s);
c374ab69
MV
335
336 return SCM_UNSPECIFIED;
337}
f48e47b9 338#undef FUNC_NAME
c374ab69
MV
339
340
b916d813 341SCM_DEFINE (scm_read_history, "read-history", 1, 0, 0,
f48e47b9
GB
342 (SCM file),
343"")
344#define FUNC_NAME s_scm_read_history
c374ab69 345{
ad6dec05
MV
346 char *filename;
347 SCM ret;
348
349 filename = scm_to_locale_string (file);
350 ret = scm_from_bool (!read_history (filename));
351 free (filename);
352 return ret;
c374ab69 353}
f48e47b9 354#undef FUNC_NAME
c374ab69
MV
355
356
b916d813 357SCM_DEFINE (scm_write_history, "write-history", 1, 0, 0,
f48e47b9
GB
358 (SCM file),
359"")
360#define FUNC_NAME s_scm_write_history
c374ab69 361{
ad6dec05
MV
362 char *filename;
363 SCM ret;
364
365 filename = scm_to_locale_string (file);
366 ret = scm_from_bool (!write_history (filename));
367 free (filename);
368 return ret;
c374ab69 369}
f48e47b9 370#undef FUNC_NAME
c374ab69 371
8ed35a15
MV
372SCM_DEFINE (scm_clear_history, "clear-history", 0, 0, 0,
373 (),
374 "Clear the history buffer of the readline machinery.")
375#define FUNC_NAME s_scm_clear_history
376{
377 clear_history();
378 return SCM_UNSPECIFIED;
379}
380#undef FUNC_NAME
381
c374ab69 382
b916d813 383SCM_DEFINE (scm_filename_completion_function, "filename-completion-function", 2, 0, 0,
f48e47b9
GB
384 (SCM text, SCM continuep),
385"")
386#define FUNC_NAME s_scm_filename_completion_function
c374ab69
MV
387{
388 char *s;
389 SCM ans;
ad6dec05 390 char *c_text = scm_to_locale_string (text);
dcb17187 391#ifdef HAVE_RL_FILENAME_COMPLETION_FUNCTION
ad6dec05 392 s = rl_filename_completion_function (c_text, scm_is_true (continuep));
dcb17187 393#else
ad6dec05 394 s = filename_completion_function (c_text, scm_is_true (continuep));
dcb17187 395#endif
ad6dec05
MV
396 ans = scm_take_locale_string (s);
397 free (c_text);
c374ab69
MV
398 return ans;
399}
f48e47b9 400#undef FUNC_NAME
c374ab69
MV
401
402/*
403 * The following has been modified from code contributed by
404 * Andrew Archibald <aarchiba@undergrad.math.uwaterloo.ca>
405 */
406
407SCM scm_readline_completion_function_var;
408
409static char *
410completion_function (char *text, int continuep)
411{
296ff5e7 412 SCM compfunc = SCM_VARIABLE_REF (scm_readline_completion_function_var);
c374ab69
MV
413 SCM res;
414
be49d1df 415 if (scm_is_false (compfunc))
c374ab69
MV
416 return NULL; /* #f => completion disabled */
417 else
418 {
ad6dec05 419 SCM t = scm_from_locale_string (text);
be49d1df 420 SCM c = scm_from_bool (continuep);
5b2a7b59 421 res = scm_apply (compfunc, scm_list_2 (t, c), SCM_EOL);
c374ab69 422
be49d1df 423 if (scm_is_false (res))
c374ab69
MV
424 return NULL;
425
ad6dec05 426 return scm_to_locale_string (res);
c374ab69
MV
427 }
428}
429
6a945c34 430#if HAVE_RL_GET_KEYMAP
c374ab69
MV
431/*Bouncing parenthesis (reimplemented by GH, 11/23/98, since readline is strict gpl)*/
432
576cdec4
MD
433static int match_paren (int x, int k);
434static int find_matching_paren (int k);
435static void init_bouncing_parens ();
c374ab69
MV
436
437static void
576cdec4 438init_bouncing_parens ()
c374ab69 439{
576cdec4
MD
440 if (strncmp (rl_get_keymap_name (rl_get_keymap ()), "vi", 2))
441 {
442 rl_bind_key (')', match_paren);
443 rl_bind_key (']', match_paren);
444 rl_bind_key ('}', match_paren);
445 }
c374ab69
MV
446}
447
448static int
449find_matching_paren(int k)
450{
451 register int i;
452 register char c = 0;
453 int end_parens_found = 0;
454
455 /* Choose the corresponding opening bracket. */
456 if (k == ')') c = '(';
457 else if (k == ']') c = '[';
458 else if (k == '}') c = '{';
459
460 for (i=rl_point-2; i>=0; i--)
461 {
462 /* Is the current character part of a character literal? */
463 if (i - 2 >= 0
464 && rl_line_buffer[i - 1] == '\\'
465 && rl_line_buffer[i - 2] == '#')
466 ;
467 else if (rl_line_buffer[i] == k)
468 end_parens_found++;
469 else if (rl_line_buffer[i] == '"')
470 {
471 /* Skip over a string literal. */
472 for (i--; i >= 0; i--)
473 if (rl_line_buffer[i] == '"'
474 && ! (i - 1 >= 0
475 && rl_line_buffer[i - 1] == '\\'))
476 break;
477 }
478 else if (rl_line_buffer[i] == c)
479 {
576cdec4
MD
480 if (end_parens_found==0)
481 return i;
c374ab69
MV
482 else --end_parens_found;
483 }
484 }
485 return -1;
486}
487
576cdec4
MD
488static int
489match_paren (int x, int k)
c374ab69 490{
8f99e3f3
SJ
491 int tmp;
492#ifndef __MINGW32__
493 int fno;
aba2031a 494 SELECT_TYPE readset;
c374ab69 495 struct timeval timeout;
8f99e3f3
SJ
496#endif
497
576cdec4 498 rl_insert (x, k);
c374ab69 499 if (!SCM_READLINE_BOUNCE_PARENS)
576cdec4 500 return 0;
c374ab69
MV
501
502 /* Did we just insert a quoted paren? If so, then don't bounce. */
503 if (rl_point - 1 >= 1
504 && rl_line_buffer[rl_point - 2] == '\\')
576cdec4 505 return 0;
c374ab69 506
8f99e3f3 507#ifndef __MINGW32__
c374ab69
MV
508 tmp = 1000 * SCM_READLINE_BOUNCE_PARENS;
509 timeout.tv_sec = tmp / 1000000;
510 timeout.tv_usec = tmp % 1000000;
576cdec4 511 FD_ZERO (&readset);
bc858b80
MD
512 fno = fileno (rl_instream);
513 FD_SET (fno, &readset);
8f99e3f3
SJ
514#endif
515
576cdec4
MD
516 if (rl_point > 1)
517 {
518 tmp = rl_point;
519 rl_point = find_matching_paren (k);
520 if (rl_point > -1)
521 {
522 rl_redisplay ();
8f99e3f3 523#ifndef __MINGW32__
0ddf47fc 524 scm_std_select (fno + 1, &readset, NULL, NULL, &timeout);
8f99e3f3
SJ
525#else
526 WaitForSingleObject (GetStdHandle(STD_INPUT_HANDLE),
527 SCM_READLINE_BOUNCE_PARENS);
528#endif
576cdec4
MD
529 }
530 rl_point = tmp;
c374ab69 531 }
576cdec4 532 return 0;
c374ab69 533}
6a945c34 534#endif /* HAVE_RL_GET_KEYMAP */
c374ab69 535
26047451
MD
536#endif /* HAVE_RL_GETC_FUNCTION */
537
c374ab69
MV
538void
539scm_init_readline ()
540{
62947883 541#ifdef HAVE_RL_GETC_FUNCTION
a0599745 542#include "guile-readline/readline.x"
c374ab69 543 scm_readline_completion_function_var
296ff5e7 544 = scm_c_define ("*readline-completion-function*", SCM_BOOL_F);
8f99e3f3 545#ifndef __MINGW32__
c374ab69 546 rl_getc_function = current_input_getc;
8f99e3f3 547#endif
dcb17187
MV
548#if defined (_RL_FUNCTION_TYPEDEF)
549 rl_completion_entry_function = (rl_compentry_func_t*) completion_function;
550#else
c374ab69 551 rl_completion_entry_function = (Function*) completion_function;
dcb17187 552#endif
4255e79f 553 rl_basic_word_break_characters = " \t\n\"'`;()";
5c11cc9d
GH
554 rl_readline_name = "Guile";
555
ddfb5e2b
AW
556 /* Let Guile handle signals. */
557#if defined (HAVE_DECL_RL_CATCH_SIGNALS) && HAVE_DECL_RL_CATCH_SIGNALS
558 rl_catch_signals = 0;
559#endif
560
561 /* But let readline handle SIGWINCH. */
562#if defined (HAVE_DECL_RL_CATCH_SIGWINCH) && HAVE_DECL_RL_CATCH_SIGWINCH
563 rl_catch_sigwinch = 1;
564#endif
565
e7efe8e7 566 reentry_barrier_mutex = scm_make_mutex ();
c374ab69 567 scm_init_opts (scm_readline_options,
07109436 568 scm_readline_opts);
6a945c34 569#if HAVE_RL_GET_KEYMAP
c374ab69 570 init_bouncing_parens();
6a945c34 571#endif
c374ab69 572 scm_add_feature ("readline");
62947883 573#endif /* HAVE_RL_GETC_FUNCTION */
c374ab69
MV
574}
575
89e00824
ML
576/*
577 Local Variables:
578 c-file-style: "gnu"
579 End:
580*/