guile-readline/readline.c

   1 /* readline.c --- line editing support for Guile */
   2
   3 /* Copyright (C) 1997,1999,2000,2001, 2002, 2003, 2006, 2007, 2008, 2009 Free Software Foundation, Inc.
   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 3, 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
  17  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  18  * Boston, MA 02110-1301 USA
  19  *
  20  */
  21
  22
  23 \f
  24 #ifdef HAVE_CONFIG_H
  25 # include <config.h>
  26 #endif
  27
  28 #ifdef HAVE_RL_GETC_FUNCTION
  29 #include "libguile.h"
  30 #include "libguile/iselect.h"
  31
  32 #include <stdio.h>
  33 #ifdef HAVE_UNISTD_H
  34 #include <unistd.h>
  35 #endif
  36 #include <readline/readline.h>
  37 #include <readline/history.h>
  38 #ifndef __MINGW32__
  39 #include <sys/time.h>
  40 #else
  41 #include <io.h>
  42 #endif
  43 #include <signal.h>
  44
  45 #include "libguile/validate.h"
  46 #include "guile-readline/readline.h"
  47
  48 scm_t_option scm_readline_opts[] = {
  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,
  54     "Time (ms) to show matching opening parenthesis (0 = off)."},
  55   { 0 }
  56 };
  57
  58 extern void stifle_history (int max);
  59
  60 SCM_DEFINE (scm_readline_options, "readline-options-interface", 0, 1, 0,
  61             (SCM setting),
  62 "")
  63 #define FUNC_NAME s_scm_readline_options
  64 {
  65   SCM ans = scm_options (setting,
  66                          scm_readline_opts,
  67                          FUNC_NAME);
  68   stifle_history (SCM_HISTORY_LENGTH);
  69   return ans;
  70 }
  71 #undef FUNC_NAME
  72
  73 #ifndef HAVE_STRDUP
  74 static char *
  75 strdup (char *s)
  76 {
  77   size_t len = strlen (s);
  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
  94 extern void _rl_clean_up_for_exit ();
  95 extern void _rl_kill_kbd_macro ();
  96 extern int _rl_init_argument ();
  97
  98 void
  99 rl_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
 111 void
 112 rl_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
 129 static int promptp;
 130 static SCM input_port;
 131 static SCM before_read;
 132
 133 static int
 134 current_input_getc (FILE *in SCM_UNUSED)
 135 {
 136   if (promptp && scm_is_true (before_read))
 137     {
 138       scm_apply (before_read, SCM_EOL, SCM_EOL);
 139       promptp = 0;
 140     }
 141   return scm_getc (input_port);
 142 }
 143
 144 static int in_readline = 0;
 145 static SCM reentry_barrier_mutex;
 146
 147 static SCM internal_readline (SCM text);
 148 static SCM handle_error (void *data, SCM tag, SCM args);
 149 static void reentry_barrier (void);
 150
 151
 152 SCM_DEFINE (scm_readline, "%readline", 0, 4, 0,
 153             (SCM text, SCM inp, SCM outp, SCM read_hook),
 154 "")
 155 #define FUNC_NAME s_scm_readline
 156 {
 157   SCM ans;
 158
 159   reentry_barrier ();
 160
 161   before_read = SCM_BOOL_F;
 162
 163   if (!SCM_UNBNDP (text))
 164     {
 165       if (!scm_is_string (text))
 166         {
 167           --in_readline;
 168           scm_wrong_type_arg (s_scm_readline, SCM_ARG1, text);
 169         }
 170     }
 171
 172   if (!((SCM_UNBNDP (inp) && SCM_OPINFPORTP (scm_current_input_port ()))
 173         || SCM_OPINFPORTP (inp)))
 174     {
 175       --in_readline;
 176       scm_misc_error (s_scm_readline,
 177                       "Input port is not open or not a file port",
 178                       SCM_EOL);
 179     }
 180
 181   if (!((SCM_UNBNDP (outp) && SCM_OPOUTFPORTP (scm_current_output_port ()))
 182         || SCM_OPOUTFPORTP (outp)))
 183     {
 184       --in_readline;
 185       scm_misc_error (s_scm_readline,
 186                       "Output port is not open or not a file port",
 187                       SCM_EOL);
 188     }
 189
 190   if (!(SCM_UNBNDP (read_hook) || scm_is_false (read_hook)))
 191     {
 192       if (scm_is_false (scm_thunk_p (read_hook)))
 193         {
 194           --in_readline;
 195           scm_wrong_type_arg (s_scm_readline, SCM_ARG4, read_hook);
 196         }
 197       before_read = read_hook;
 198     }
 199
 200   scm_readline_init_ports (inp, outp);
 201
 202   ans = scm_internal_catch (SCM_BOOL_T,
 203                             (scm_t_catch_body) internal_readline,
 204                             (void *) SCM_UNPACK (text),
 205                             handle_error, 0);
 206
 207 #ifndef __MINGW32__
 208   fclose (rl_instream);
 209   fclose (rl_outstream);
 210 #endif
 211
 212   --in_readline;
 213   return ans;
 214 }
 215 #undef FUNC_NAME
 216
 217
 218 static void
 219 reentry_barrier ()
 220 {
 221   int reentryp = 0;
 222   /* We should rather use scm_try_mutex when it becomes available */
 223   scm_lock_mutex (reentry_barrier_mutex);
 224   if (in_readline)
 225     reentryp = 1;
 226   else
 227     ++in_readline;
 228   scm_unlock_mutex (reentry_barrier_mutex);
 229   if (reentryp)
 230     scm_misc_error (s_scm_readline, "readline is not reentrant", SCM_EOL);
 231 }
 232
 233 static SCM
 234 handle_error (void *data, SCM tag, SCM args)
 235 {
 236   rl_free_line_state ();
 237   rl_cleanup_after_signal ();
 238   fputc ('\n', rl_outstream); /* We don't want next output on this line */
 239 #ifndef __MINGW32__
 240   fclose (rl_instream);
 241   fclose (rl_outstream);
 242 #endif
 243   --in_readline;
 244   scm_handle_by_throw (data, tag, args);
 245   return SCM_UNSPECIFIED; /* never reached */
 246 }
 247
 248 static SCM
 249 internal_readline (SCM text)
 250 {
 251   SCM ret;
 252   char *s;
 253   char *prompt = SCM_UNBNDP (text) ? "" : scm_to_locale_string (text);
 254
 255   promptp = 1;
 256   s = readline (prompt);
 257   if (s)
 258     ret = scm_from_locale_string (s);
 259   else
 260     ret = SCM_EOF_VAL;
 261
 262   if (!SCM_UNBNDP (text))
 263     free (prompt);
 264   free (s);
 265
 266   return ret;
 267 }
 268
 269 static FILE *
 270 stream_from_fport (SCM port, char *mode, const char *subr)
 271 {
 272   int fd;
 273   FILE *f;
 274
 275   fd = dup (((struct scm_t_fport *) SCM_STREAM (port))->fdes);
 276   if (fd == -1)
 277     {
 278       --in_readline;
 279       scm_syserror (subr);
 280     }
 281
 282   f = fdopen (fd, mode);
 283   if (f == NULL)
 284     {
 285       --in_readline;
 286       scm_syserror (subr);
 287     }
 288
 289   return f;
 290 }
 291
 292 void
 293 scm_readline_init_ports (SCM inp, SCM outp)
 294 {
 295   if (SCM_UNBNDP (inp))
 296     inp = scm_current_input_port ();
 297
 298   if (SCM_UNBNDP (outp))
 299     outp = scm_current_output_port ();
 300
 301   if (!SCM_OPINFPORTP (inp)) {
 302     scm_misc_error (0,
 303                     "Input port is not open or not a file port",
 304                     SCM_EOL);
 305   }
 306
 307   if (!SCM_OPOUTFPORTP (outp)) {
 308     scm_misc_error (0,
 309                     "Output port is not open or not a file port",
 310                     SCM_EOL);
 311   }
 312
 313   input_port = inp;
 314 #ifndef __MINGW32__
 315   rl_instream = stream_from_fport (inp, "r", s_scm_readline);
 316   rl_outstream = stream_from_fport (outp, "w", s_scm_readline);
 317 #endif
 318 }
 319
 320
 321
 322 SCM_DEFINE (scm_add_history, "add-history", 1, 0, 0,
 323             (SCM text),
 324 "")
 325 #define FUNC_NAME s_scm_add_history
 326 {
 327   char* s;
 328
 329   s = scm_to_locale_string (text);
 330   add_history (s);
 331   free (s);
 332
 333   return SCM_UNSPECIFIED;
 334 }
 335 #undef FUNC_NAME
 336
 337
 338 SCM_DEFINE (scm_read_history, "read-history", 1, 0, 0,
 339             (SCM file),
 340 "")
 341 #define FUNC_NAME s_scm_read_history
 342 {
 343   char *filename;
 344   SCM ret;
 345
 346   filename = scm_to_locale_string (file);
 347   ret = scm_from_bool (!read_history (filename));
 348   free (filename);
 349   return ret;
 350 }
 351 #undef FUNC_NAME
 352
 353
 354 SCM_DEFINE (scm_write_history, "write-history", 1, 0, 0,
 355             (SCM file),
 356 "")
 357 #define FUNC_NAME s_scm_write_history
 358 {
 359   char *filename;
 360   SCM ret;
 361
 362   filename = scm_to_locale_string (file);
 363   ret = scm_from_bool (!write_history (filename));
 364   free (filename);
 365   return ret;
 366 }
 367 #undef FUNC_NAME
 368
 369 SCM_DEFINE (scm_clear_history, "clear-history", 0, 0, 0,
 370             (),
 371             "Clear the history buffer of the readline machinery.")
 372 #define FUNC_NAME s_scm_clear_history
 373 {
 374   clear_history();
 375   return SCM_UNSPECIFIED;
 376 }
 377 #undef FUNC_NAME
 378
 379
 380 SCM_DEFINE (scm_filename_completion_function, "filename-completion-function", 2, 0, 0,
 381             (SCM text, SCM continuep),
 382 "")
 383 #define FUNC_NAME s_scm_filename_completion_function
 384 {
 385   char *s;
 386   SCM ans;
 387   char *c_text = scm_to_locale_string (text);
 388 #ifdef HAVE_RL_FILENAME_COMPLETION_FUNCTION
 389   s = rl_filename_completion_function (c_text, scm_is_true (continuep));
 390 #else
 391   s = filename_completion_function (c_text, scm_is_true (continuep));
 392 #endif
 393   ans = scm_take_locale_string (s);
 394   free (c_text);
 395   return ans;
 396 }
 397 #undef FUNC_NAME
 398
 399 /*
 400  * The following has been modified from code contributed by
 401  * Andrew Archibald <aarchiba@undergrad.math.uwaterloo.ca>
 402  */
 403
 404 SCM scm_readline_completion_function_var;
 405
 406 static char *
 407 completion_function (char *text, int continuep)
 408 {
 409   SCM compfunc = SCM_VARIABLE_REF (scm_readline_completion_function_var);
 410   SCM res;
 411
 412   if (scm_is_false (compfunc))
 413     return NULL; /* #f => completion disabled */
 414   else
 415     {
 416       SCM t = scm_from_locale_string (text);
 417       SCM c = scm_from_bool (continuep);
 418       res = scm_apply (compfunc, scm_list_2 (t, c), SCM_EOL);
 419
 420       if (scm_is_false (res))
 421         return NULL;
 422
 423       return scm_to_locale_string (res);
 424     }
 425 }
 426
 427 #if HAVE_RL_GET_KEYMAP
 428 /*Bouncing parenthesis (reimplemented by GH, 11/23/98, since readline is strict gpl)*/
 429
 430 static int match_paren (int x, int k);
 431 static int find_matching_paren (int k);
 432 static void init_bouncing_parens ();
 433
 434 static void
 435 init_bouncing_parens ()
 436 {
 437   if (strncmp (rl_get_keymap_name (rl_get_keymap ()), "vi", 2))
 438     {
 439       rl_bind_key (')', match_paren);
 440       rl_bind_key (']', match_paren);
 441       rl_bind_key ('}', match_paren);
 442     }
 443 }
 444
 445 static int
 446 find_matching_paren(int k)
 447 {
 448   register int i;
 449   register char c = 0;
 450   int end_parens_found = 0;
 451
 452   /* Choose the corresponding opening bracket.  */
 453   if (k == ')') c = '(';
 454   else if (k == ']') c = '[';
 455   else if (k == '}') c = '{';
 456
 457   for (i=rl_point-2; i>=0; i--)
 458     {
 459       /* Is the current character part of a character literal?  */
 460       if (i - 2 >= 0
 461           && rl_line_buffer[i - 1] == '\\'
 462           && rl_line_buffer[i - 2] == '#')
 463         ;
 464       else if (rl_line_buffer[i] == k)
 465         end_parens_found++;
 466       else if (rl_line_buffer[i] == '"')
 467         {
 468           /* Skip over a string literal.  */
 469           for (i--; i >= 0; i--)
 470             if (rl_line_buffer[i] == '"'
 471                 && ! (i - 1 >= 0
 472                       && rl_line_buffer[i - 1] == '\\'))
 473               break;
 474         }
 475       else if (rl_line_buffer[i] == c)
 476         {
 477           if (end_parens_found==0)
 478             return i;
 479           else --end_parens_found;
 480         }
 481     }
 482   return -1;
 483 }
 484
 485 static int
 486 match_paren (int x, int k)
 487 {
 488   int tmp;
 489 #ifndef __MINGW32__
 490   int fno;
 491   SELECT_TYPE readset;
 492   struct timeval timeout;
 493 #endif
 494
 495   rl_insert (x, k);
 496   if (!SCM_READLINE_BOUNCE_PARENS)
 497     return 0;
 498
 499   /* Did we just insert a quoted paren?  If so, then don't bounce.  */
 500   if (rl_point - 1 >= 1
 501       && rl_line_buffer[rl_point - 2] == '\\')
 502     return 0;
 503
 504 #ifndef __MINGW32__
 505   tmp = 1000 * SCM_READLINE_BOUNCE_PARENS;
 506   timeout.tv_sec = tmp / 1000000;
 507   timeout.tv_usec = tmp % 1000000;
 508   FD_ZERO (&readset);
 509   fno = fileno (rl_instream);
 510   FD_SET (fno, &readset);
 511 #endif
 512
 513   if (rl_point > 1)
 514     {
 515       tmp = rl_point;
 516       rl_point = find_matching_paren (k);
 517       if (rl_point > -1)
 518         {
 519           rl_redisplay ();
 520 #ifndef __MINGW32__
 521           scm_std_select (fno + 1, &readset, NULL, NULL, &timeout);
 522 #else
 523           WaitForSingleObject (GetStdHandle(STD_INPUT_HANDLE),
 524                                SCM_READLINE_BOUNCE_PARENS);
 525 #endif
 526         }
 527       rl_point = tmp;
 528     }
 529   return 0;
 530 }
 531 #endif /* HAVE_RL_GET_KEYMAP */
 532
 533 #endif /* HAVE_RL_GETC_FUNCTION */
 534
 535 void
 536 scm_init_readline ()
 537 {
 538 #ifdef HAVE_RL_GETC_FUNCTION
 539 #include "guile-readline/readline.x"
 540   scm_readline_completion_function_var
 541     = scm_c_define ("*readline-completion-function*", SCM_BOOL_F);
 542 #ifndef __MINGW32__
 543   rl_getc_function = current_input_getc;
 544 #endif
 545 #if defined (_RL_FUNCTION_TYPEDEF)
 546   rl_completion_entry_function = (rl_compentry_func_t*) completion_function;
 547 #else
 548   rl_completion_entry_function = (Function*) completion_function;
 549 #endif
 550   rl_basic_word_break_characters = "\t\n\"'`;()";
 551   rl_readline_name = "Guile";
 552
 553   reentry_barrier_mutex = scm_permanent_object (scm_make_mutex ());
 554   scm_init_opts (scm_readline_options,
 555                  scm_readline_opts);
 556 #if HAVE_RL_GET_KEYMAP
 557   init_bouncing_parens();
 558 #endif
 559   scm_add_feature ("readline");
 560 #endif /* HAVE_RL_GETC_FUNCTION */
 561 }
 562
 563 /*
 564   Local Variables:
 565   c-file-style: "gnu"
 566   End:
 567 */