source/lib/cmdline/readline.c

   1 /*
   2    Unix SMB/CIFS implementation.
   3    Samba readline wrapper implementation
   4    Copyright (C) Simo Sorce 2001
   5    Copyright (C) Andrew Tridgell 2001
   6
   7    This program is free software; you can redistribute it and/or modify
   8    it under the terms of the GNU General Public License as published by
   9    the Free Software Foundation; either version 2 of the License, or
  10    (at your option) any later version.
  11
  12    This program is distributed in the hope that it will be useful,
  13    but WITHOUT ANY WARRANTY; without even the implied warranty of
  14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15    GNU General Public License for more details.
  16
  17    You should have received a copy of the GNU General Public License
  18    along with this program; if not, write to the Free Software
  19    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  20 */
  21
  22 #include "includes.h"
  23 #include "pstring.h"
  24
  25 #include <unistd.h>
  26
  27 #ifdef HAVE_LIBREADLINE
  28 #  ifdef HAVE_READLINE_READLINE_H
  29 #    include <readline/readline.h>
  30 #    ifdef HAVE_READLINE_HISTORY_H
  31 #      include <readline/history.h>
  32 #    endif
  33 #  else
  34 #    ifdef HAVE_READLINE_H
  35 #      include <readline.h>
  36 #      ifdef HAVE_HISTORY_H
  37 #        include <history.h>
  38 #      endif
  39 #    else
  40 #      undef HAVE_LIBREADLINE
  41 #    endif
  42 #  endif
  43 #endif
  44
  45 #ifdef HAVE_NEW_LIBREADLINE
  46 #  define RL_COMPLETION_CAST (rl_completion_func_t *)
  47 #else
  48 /* This type is missing from libreadline<4.0  (approximately) */
  49 #  define RL_COMPLETION_CAST
  50 #endif /* HAVE_NEW_LIBREADLINE */
  51
  52 /****************************************************************************
  53  Display the prompt and wait for input. Call callback() regularly
  54 ****************************************************************************/
  55
  56 static char *smb_readline_replacement(const char *prompt, void (*callback)(void),
  57                                       char **(completion_fn)(const char *text, int start, int end))
  58 {
  59         fd_set fds;
  60         static pstring line;
  61         struct timeval timeout;
  62         int fd = STDIN_FILENO;
  63         char *ret;
  64
  65         do_debug("%s", prompt);
  66
  67         while (1) {
  68                 timeout.tv_sec = 5;
  69                 timeout.tv_usec = 0;
  70
  71                 FD_ZERO(&fds);
  72                 FD_SET(fd,&fds);
  73
  74                 if (sys_select_intr(fd+1,&fds,NULL,NULL,&timeout) == 1) {
  75                         ret = x_fgets(line, sizeof(line), x_stdin);
  76                         return ret;
  77                 }
  78                 if (callback)
  79                         callback();
  80         }
  81 }
  82
  83 /****************************************************************************
  84  Display the prompt and wait for input. Call callback() regularly.
  85 ****************************************************************************/
  86
  87 char *smb_readline(const char *prompt, void (*callback)(void),
  88                    char **(completion_fn)(const char *text, int start, int end))
  89 {
  90 #if HAVE_LIBREADLINE
  91         if (isatty(STDIN_FILENO)) {
  92                 char *ret;
  93
  94                 /* Aargh!  Readline does bizzare things with the terminal width
  95                 that mucks up expect(1).  Set CLI_NO_READLINE in the environment
  96                 to force readline not to be used. */
  97
  98                 if (getenv("CLI_NO_READLINE"))
  99                         return smb_readline_replacement(prompt, callback, completion_fn);
 100
 101                 if (completion_fn) {
 102                         /* The callback prototype has changed slightly between
 103                         different versions of Readline, so the same function
 104                         works in all of them to date, but we get compiler
 105                         warnings in some.  */
 106                         rl_attempted_completion_function = RL_COMPLETION_CAST completion_fn;
 107                 }
 108
 109                 if (callback)
 110                         rl_event_hook = (Function *)callback;
 111                 ret = readline(prompt);
 112                 if (ret && *ret)
 113                         add_history(ret);
 114                 return ret;
 115         } else
 116 #endif
 117         return smb_readline_replacement(prompt, callback, completion_fn);
 118 }
 119
 120 /****************************************************************************
 121  * return line buffer text
 122  ****************************************************************************/
 123 const char *smb_readline_get_line_buffer(void)
 124 {
 125 #if defined(HAVE_LIBREADLINE)
 126         return rl_line_buffer;
 127 #else
 128         return NULL;
 129 #endif
 130 }
 131
 132 /****************************************************************************
 133  * set completion append character
 134  ***************************************************************************/
 135 void smb_readline_ca_char(char c)
 136 {
 137 #if defined(HAVE_LIBREADLINE)
 138         rl_completion_append_character = c;
 139 #endif
 140 }
 141
 142
 143