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, 2010 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 output_port;
 132 static SCM before_read;
 133
 134 static int
 135 current_input_getc (FILE *in SCM_UNUSED)
 136 {
 137   if (promptp && scm_is_true (before_read))
 138     {
 139       scm_apply (before_read, SCM_EOL, SCM_EOL);
 140       promptp = 0;
 141     }
 142   return scm_get_byte_or_eof (input_port);
 143 }
 144
 145 static int in_readline = 0;
 146 static SCM reentry_barrier_mutex;
 147
 148 static SCM internal_readline (SCM text);
 149 static void unwind_readline (void *unused);
 150 static void reentry_barrier (void);
 151
 152
 153 SCM_DEFINE (scm_readline, "%readline", 0, 4, 0,
 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     {
 166       if (!scm_is_string (text))
 167         {
 168           --in_readline;
 169           scm_wrong_type_arg (s_scm_readline, SCM_ARG1, text);
 170         }
 171     }
 172
 173   if (!((SCM_UNBNDP (inp) && SCM_OPINFPORTP (scm_current_input_port ()))
 174         || SCM_OPINFPORTP (inp)))
 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
 182   if (!((SCM_UNBNDP (outp) && SCM_OPOUTFPORTP (scm_current_output_port ()))
 183         || SCM_OPOUTFPORTP (outp)))
 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
 191   if (!(SCM_UNBNDP (read_hook) || scm_is_false (read_hook)))
 192     {
 193       if (scm_is_false (scm_thunk_p (read_hook)))
 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
 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 ();
 209
 210 #ifndef __MINGW32__
 211   fclose (rl_instream);
 212   fclose (rl_outstream);
 213 #endif
 214
 215   --in_readline;
 216   return ans;
 217 }
 218 #undef FUNC_NAME
 219
 220
 221 static void
 222 reentry_barrier ()
 223 {
 224   int reentryp = 0;
 225   /* We should rather use scm_try_mutex when it becomes available */
 226   scm_lock_mutex (reentry_barrier_mutex);
 227   if (in_readline)
 228     reentryp = 1;
 229   else
 230     ++in_readline;
 231   scm_unlock_mutex (reentry_barrier_mutex);
 232   if (reentryp)
 233     scm_misc_error (s_scm_readline, "readline is not reentrant", SCM_EOL);
 234 }
 235
 236 /* This function is only called on nonlocal exit from readline(). */
 237 static void
 238 unwind_readline (void *unused)
 239 {
 240   rl_free_line_state ();
 241   rl_cleanup_after_signal ();
 242   fputc ('\n', rl_outstream); /* We don't want next output on this line */
 243 #ifndef __MINGW32__
 244   fclose (rl_instream);
 245   fclose (rl_outstream);
 246 #endif
 247   --in_readline;
 248 }
 249
 250 static SCM
 251 internal_readline (SCM text)
 252 {
 253   SCM ret;
 254   char *s;
 255   char *prompt = SCM_UNBNDP (text) ? "" : scm_to_locale_string (text);
 256
 257   promptp = 1;
 258   s = readline (prompt);
 259   if (s)
 260     {
 261       scm_t_port *pt = SCM_PTAB_ENTRY (output_port);
 262
 263       ret = scm_from_stringn (s, strlen (s), pt->encoding,
 264                               SCM_FAILED_CONVERSION_ESCAPE_SEQUENCE);
 265     }
 266   else
 267     ret = SCM_EOF_VAL;
 268
 269   if (!SCM_UNBNDP (text))
 270     free (prompt);
 271   free (s);
 272
 273   return ret;
 274 }
 275
 276 static FILE *
 277 stream_from_fport (SCM port, char *mode, const char *subr)
 278 {
 279   int fd;
 280   FILE *f;
 281
 282   fd = dup (((struct scm_t_fport *) SCM_STREAM (port))->fdes);
 283   if (fd == -1)
 284     {
 285       --in_readline;
 286       scm_syserror (subr);
 287     }
 288
 289   f = fdopen (fd, mode);
 290   if (f == NULL)
 291     {
 292       --in_readline;
 293       scm_syserror (subr);
 294     }
 295
 296   return f;
 297 }
 298
 299 void
 300 scm_readline_init_ports (SCM inp, SCM outp)
 301 {
 302   if (SCM_UNBNDP (inp))
 303     inp = scm_current_input_port ();
 304
 305   if (SCM_UNBNDP (outp))
 306     outp = scm_current_output_port ();
 307
 308   if (!SCM_OPINFPORTP (inp)) {
 309     scm_misc_error (0,
 310                     "Input port is not open or not a file port",
 311                     SCM_EOL);
 312   }
 313
 314   if (!SCM_OPOUTFPORTP (outp)) {
 315     scm_misc_error (0,
 316                     "Output port is not open or not a file port",
 317                     SCM_EOL);
 318   }
 319
 320   input_port = inp;
 321   output_port = outp;
 322 #ifndef __MINGW32__
 323   rl_instream = stream_from_fport (inp, "r", s_scm_readline);
 324   rl_outstream = stream_from_fport (outp, "w", s_scm_readline);
 325 #endif
 326 }
 327
 328
 329
 330 SCM_DEFINE (scm_add_history, "add-history", 1, 0, 0,
 331             (SCM text),
 332 "")
 333 #define FUNC_NAME s_scm_add_history
 334 {
 335   char* s;
 336
 337   s = scm_to_locale_string (text);
 338   add_history (s);
 339   free (s);
 340
 341   return SCM_UNSPECIFIED;
 342 }
 343 #undef FUNC_NAME
 344
 345
 346 SCM_DEFINE (scm_read_history, "read-history", 1, 0, 0,
 347             (SCM file),
 348 "")
 349 #define FUNC_NAME s_scm_read_history
 350 {
 351   char *filename;
 352   SCM ret;
 353
 354   filename = scm_to_locale_string (file);
 355   ret = scm_from_bool (!read_history (filename));
 356   free (filename);
 357   return ret;
 358 }
 359 #undef FUNC_NAME
 360
 361
 362 SCM_DEFINE (scm_write_history, "write-history", 1, 0, 0,
 363             (SCM file),
 364 "")
 365 #define FUNC_NAME s_scm_write_history
 366 {
 367   char *filename;
 368   SCM ret;
 369
 370   filename = scm_to_locale_string (file);
 371   ret = scm_from_bool (!write_history (filename));
 372   free (filename);
 373   return ret;
 374 }
 375 #undef FUNC_NAME
 376
 377 SCM_DEFINE (scm_clear_history, "clear-history", 0, 0, 0,
 378             (),
 379             "Clear the history buffer of the readline machinery.")
 380 #define FUNC_NAME s_scm_clear_history
 381 {
 382   clear_history();
 383   return SCM_UNSPECIFIED;
 384 }
 385 #undef FUNC_NAME
 386
 387
 388 SCM_DEFINE (scm_filename_completion_function, "filename-completion-function", 2, 0, 0,
 389             (SCM text, SCM continuep),
 390 "")
 391 #define FUNC_NAME s_scm_filename_completion_function
 392 {
 393   char *s;
 394   SCM ans;
 395   char *c_text = scm_to_locale_string (text);
 396 #ifdef HAVE_RL_FILENAME_COMPLETION_FUNCTION
 397   s = rl_filename_completion_function (c_text, scm_is_true (continuep));
 398 #else
 399   s = filename_completion_function (c_text, scm_is_true (continuep));
 400 #endif
 401   ans = scm_take_locale_string (s);
 402   free (c_text);
 403   return ans;
 404 }
 405 #undef FUNC_NAME
 406
 407 /*
 408  * The following has been modified from code contributed by
 409  * Andrew Archibald <aarchiba@undergrad.math.uwaterloo.ca>
 410  */
 411
 412 SCM scm_readline_completion_function_var;
 413
 414 static char *
 415 completion_function (char *text, int continuep)
 416 {
 417   SCM compfunc = SCM_VARIABLE_REF (scm_readline_completion_function_var);
 418   SCM res;
 419
 420   if (scm_is_false (compfunc))
 421     return NULL; /* #f => completion disabled */
 422   else
 423     {
 424       SCM t = scm_from_locale_string (text);
 425       SCM c = scm_from_bool (continuep);
 426       res = scm_apply (compfunc, scm_list_2 (t, c), SCM_EOL);
 427
 428       if (scm_is_false (res))
 429         return NULL;
 430
 431       return scm_to_locale_string (res);
 432     }
 433 }
 434
 435 #if HAVE_RL_GET_KEYMAP
 436 /*Bouncing parenthesis (reimplemented by GH, 11/23/98, since readline is strict gpl)*/
 437
 438 static int match_paren (int x, int k);
 439 static int find_matching_paren (int k);
 440 static void init_bouncing_parens ();
 441
 442 static void
 443 init_bouncing_parens ()
 444 {
 445   if (strncmp (rl_get_keymap_name (rl_get_keymap ()), "vi", 2))
 446     {
 447       rl_bind_key (')', match_paren);
 448       rl_bind_key (']', match_paren);
 449       rl_bind_key ('}', match_paren);
 450     }
 451 }
 452
 453 static int
 454 find_matching_paren(int k)
 455 {
 456   register int i;
 457   register char c = 0;
 458   int end_parens_found = 0;
 459
 460   /* Choose the corresponding opening bracket.  */
 461   if (k == ')') c = '(';
 462   else if (k == ']') c = '[';
 463   else if (k == '}') c = '{';
 464
 465   for (i=rl_point-2; i>=0; i--)
 466     {
 467       /* Is the current character part of a character literal?  */
 468       if (i - 2 >= 0
 469           && rl_line_buffer[i - 1] == '\\'
 470           && rl_line_buffer[i - 2] == '#')
 471         ;
 472       else if (rl_line_buffer[i] == k)
 473         end_parens_found++;
 474       else if (rl_line_buffer[i] == '"')
 475         {
 476           /* Skip over a string literal.  */
 477           for (i--; i >= 0; i--)
 478             if (rl_line_buffer[i] == '"'
 479                 && ! (i - 1 >= 0
 480                       && rl_line_buffer[i - 1] == '\\'))
 481               break;
 482         }
 483       else if (rl_line_buffer[i] == c)
 484         {
 485           if (end_parens_found==0)
 486             return i;
 487           else --end_parens_found;
 488         }
 489     }
 490   return -1;
 491 }
 492
 493 static int
 494 match_paren (int x, int k)
 495 {
 496   int tmp;
 497 #ifndef __MINGW32__
 498   int fno;
 499   SELECT_TYPE readset;
 500   struct timeval timeout;
 501 #endif
 502
 503   rl_insert (x, k);
 504   if (!SCM_READLINE_BOUNCE_PARENS)
 505     return 0;
 506
 507   /* Did we just insert a quoted paren?  If so, then don't bounce.  */
 508   if (rl_point - 1 >= 1
 509       && rl_line_buffer[rl_point - 2] == '\\')
 510     return 0;
 511
 512 #ifndef __MINGW32__
 513   tmp = 1000 * SCM_READLINE_BOUNCE_PARENS;
 514   timeout.tv_sec = tmp / 1000000;
 515   timeout.tv_usec = tmp % 1000000;
 516   FD_ZERO (&readset);
 517   fno = fileno (rl_instream);
 518   FD_SET (fno, &readset);
 519 #endif
 520
 521   if (rl_point > 1)
 522     {
 523       tmp = rl_point;
 524       rl_point = find_matching_paren (k);
 525       if (rl_point > -1)
 526         {
 527           rl_redisplay ();
 528 #ifndef __MINGW32__
 529           scm_std_select (fno + 1, &readset, NULL, NULL, &timeout);
 530 #else
 531           WaitForSingleObject (GetStdHandle(STD_INPUT_HANDLE),
 532                                SCM_READLINE_BOUNCE_PARENS);
 533 #endif
 534         }
 535       rl_point = tmp;
 536     }
 537   return 0;
 538 }
 539 #endif /* HAVE_RL_GET_KEYMAP */
 540
 541 #endif /* HAVE_RL_GETC_FUNCTION */
 542
 543 void
 544 scm_init_readline ()
 545 {
 546 #ifdef HAVE_RL_GETC_FUNCTION
 547 #include "guile-readline/readline.x"
 548   scm_readline_completion_function_var
 549     = scm_c_define ("*readline-completion-function*", SCM_BOOL_F);
 550 #ifndef __MINGW32__
 551   rl_getc_function = current_input_getc;
 552 #endif
 553 #if defined (_RL_FUNCTION_TYPEDEF)
 554   rl_completion_entry_function = (rl_compentry_func_t*) completion_function;
 555 #else
 556   rl_completion_entry_function = (Function*) completion_function;
 557 #endif
 558   rl_basic_word_break_characters = " \t\n\"'`;()";
 559   rl_readline_name = "Guile";
 560
 561   /* Let Guile handle signals. */
 562 #if defined (HAVE_DECL_RL_CATCH_SIGNALS) && HAVE_DECL_RL_CATCH_SIGNALS
 563   rl_catch_signals = 0;
 564 #endif
 565
 566   /* But let readline handle SIGWINCH. */
 567 #if defined (HAVE_DECL_RL_CATCH_SIGWINCH) && HAVE_DECL_RL_CATCH_SIGWINCH
 568   rl_catch_sigwinch = 1;
 569 #endif
 570
 571   reentry_barrier_mutex = scm_make_mutex ();
 572   scm_init_opts (scm_readline_options,
 573                  scm_readline_opts);
 574 #if HAVE_RL_GET_KEYMAP
 575   init_bouncing_parens();
 576 #endif
 577   scm_add_feature ("readline");
 578 #endif /* HAVE_RL_GETC_FUNCTION */
 579 }
 580
 581 /*
 582   Local Variables:
 583   c-file-style: "gnu"
 584   End:
 585 */