source/lib/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 3 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, see <http://www.gnu.org/licenses/>.
  19 */
  20
  21 #include "includes.h"
  22
  23 #ifdef HAVE_LIBREADLINE
  24 #  ifdef HAVE_READLINE_READLINE_H
  25 #    include <readline/readline.h>
  26 #    ifdef HAVE_READLINE_HISTORY_H
  27 #      include <readline/history.h>
  28 #    endif
  29 #  else
  30 #    ifdef HAVE_READLINE_H
  31 #      include <readline.h>
  32 #      ifdef HAVE_HISTORY_H
  33 #        include <history.h>
  34 #      endif
  35 #    else
  36 #      undef HAVE_LIBREADLINE
  37 #    endif
  38 #  endif
  39 #endif
  40
  41 #ifdef HAVE_NEW_LIBREADLINE
  42 #  define RL_COMPLETION_CAST (rl_completion_func_t *)
  43 #else
  44 /* This type is missing from libreadline<4.0  (approximately) */
  45 #  define RL_COMPLETION_CAST
  46 #endif /* HAVE_NEW_LIBREADLINE */
  47
  48 /****************************************************************************
  49  Display the prompt and wait for input. Call callback() regularly
  50 ****************************************************************************/
  51
  52 static char *smb_readline_replacement(const char *prompt, void (*callback)(void),
  53                                 char **(completion_fn)(const char *text, int start, int end))
  54 {
  55         fd_set fds;
  56         static char *line;
  57         struct timeval timeout;
  58         int fd = x_fileno(x_stdin);
  59         char *ret;
  60
  61         /* Prompt might be NULL in non-interactive mode. */
  62         if (prompt) {
  63                 x_fprintf(x_stdout, "%s", prompt);
  64                 x_fflush(x_stdout);
  65         }
  66
  67         if (line == NULL) {
  68                 line = (char *)SMB_MALLOC(BUFSIZ);
  69                 if (!line) {
  70                         return NULL;
  71                 }
  72         }
  73
  74         while (1) {
  75                 timeout.tv_sec = 5;
  76                 timeout.tv_usec = 0;
  77
  78                 FD_ZERO(&fds);
  79                 FD_SET(fd,&fds);
  80
  81                 if (sys_select_intr(fd+1,&fds,NULL,NULL,&timeout) == 1) {
  82                         ret = x_fgets(line, BUFSIZ, x_stdin);
  83                         return ret;
  84                 }
  85                 if (callback)
  86                         callback();
  87         }
  88 }
  89
  90 /****************************************************************************
  91  Display the prompt and wait for input. Call callback() regularly.
  92 ****************************************************************************/
  93
  94 char *smb_readline(const char *prompt, void (*callback)(void),
  95                    char **(completion_fn)(const char *text, int start, int end))
  96 {
  97         char *ret;
  98         bool interactive;
  99
 100         interactive = isatty(x_fileno(x_stdin)) || getenv("CLI_FORCE_INTERACTIVE");
 101         if (!interactive) {
 102             return smb_readline_replacement(NULL, callback, completion_fn);
 103         }
 104
 105 #if HAVE_LIBREADLINE
 106
 107         /* Aargh!  Readline does bizzare things with the terminal width
 108         that mucks up expect(1).  Set CLI_NO_READLINE in the environment
 109         to force readline not to be used. */
 110
 111         if (getenv("CLI_NO_READLINE"))
 112                 return smb_readline_replacement(prompt, callback, completion_fn);
 113
 114         if (completion_fn) {
 115                 /* The callback prototype has changed slightly between
 116                 different versions of Readline, so the same function
 117                 works in all of them to date, but we get compiler
 118                 warnings in some.  */
 119                 rl_attempted_completion_function = RL_COMPLETION_CAST completion_fn;
 120         }
 121
 122 #if HAVE_DECL_RL_EVENT_HOOK
 123         if (callback)
 124                 rl_event_hook = (Function *)callback;
 125 #endif
 126         ret = readline(prompt);
 127         if (ret && *ret)
 128                 add_history(ret);
 129
 130 #else
 131         ret = smb_readline_replacement(prompt, callback, completion_fn);
 132 #endif
 133
 134         return ret;
 135 }
 136
 137 /****************************************************************************
 138  * return line buffer text
 139  ****************************************************************************/
 140 const char *smb_readline_get_line_buffer(void)
 141 {
 142 #if defined(HAVE_LIBREADLINE)
 143         return rl_line_buffer;
 144 #else
 145         return NULL;
 146 #endif
 147 }
 148
 149
 150 /****************************************************************************
 151  * set completion append character
 152  ***************************************************************************/
 153 void smb_readline_ca_char(char c)
 154 {
 155 #if defined(HAVE_LIBREADLINE)
 156         rl_completion_append_character = c;
 157 #endif
 158 }
 159
 160 /****************************************************************************
 161 history
 162 ****************************************************************************/
 163 int cmd_history(void)
 164 {
 165 #if defined(HAVE_LIBREADLINE) && defined(HAVE_HISTORY_LIST)
 166         HIST_ENTRY **hlist;
 167         int i;
 168
 169         hlist = history_list();
 170
 171         for (i = 0; hlist && hlist[i]; i++) {
 172                 DEBUG(0, ("%d: %s\n", i, hlist[i]->line));
 173         }
 174 #else
 175         DEBUG(0,("no history without readline support\n"));
 176 #endif
 177
 178         return 0;
 179 }
 180