xio-readline.c

   1 /* source: xio-readline.c */
   2 /* Copyright Gerhard Rieger 2002-2008 */
   3 /* Published under the GNU General Public License V.2, see file COPYING */
   4
   5 /* this file contains the source for opening the readline address */
   6
   7 #include "xiosysincludes.h"
   8 #include "xioopen.h"
   9
  10 #include "xio-termios.h"
  11 #include "xio-readline.h"
  12
  13
  14 #if WITH_READLINE
  15
  16 /*
  17 options: history file
  18         prompt
  19         mode=vi?
  20         inputrc=?
  21
  22 uses stdin!!
  23 */
  24
  25 /* length of buffer for dynamic prompt */
  26 #define READLINE_MAXPROMPT 512
  27
  28 static int xioopen_readline(int argc, const char *argv[], struct opt *opts,
  29                             int rw, xiofile_t *xfd, unsigned groups,
  30                             int dummy1, int dummy2, int dummy3);
  31
  32
  33 const struct addrdesc addr_readline = {
  34    "readline", 3, xioopen_readline, GROUP_FD|GROUP_TERMIOS|GROUP_READLINE, 0, 0, 0 HELP(NULL) };
  35
  36 const struct optdesc opt_history_file = { "history-file", "history", OPT_HISTORY_FILE, GROUP_READLINE, PH_LATE, TYPE_STRING, OFUNC_OFFSET, (int)&((xiofile_t *)0)->stream.para.readline.history_file };
  37 const struct optdesc opt_prompt       = { "prompt",       NULL,      OPT_PROMPT,       GROUP_READLINE, PH_LATE, TYPE_STRING, OFUNC_OFFSET, (int)&((xiofile_t *)0)->stream.para.readline.prompt };
  38 const struct optdesc opt_noprompt     = { "noprompt",     NULL,      OPT_NOPROMPT,     GROUP_READLINE, PH_LATE, TYPE_BOOL,   OFUNC_SPEC,   0 };
  39 const struct optdesc opt_noecho       = { "noecho",       NULL,      OPT_NOECHO,       GROUP_READLINE, PH_LATE, TYPE_STRING, OFUNC_SPEC,   0 };
  40
  41 static int xioopen_readline(int argc, const char *argv[], struct opt *opts,
  42                             int xioflags, xiofile_t *xfd, unsigned groups,
  43                             int dummy1, int dummy2, int dummy3) {
  44    int rw = (xioflags & XIO_ACCMODE);
  45    char msgbuf[256], *cp = msgbuf;
  46    bool noprompt = false;
  47    char *noecho = NULL;
  48
  49    if (argc != 1) {
  50       Error1("%s: 0 parameters required", argv[0]);
  51       return STAT_NORETRY;
  52    }
  53
  54    if (!(xioflags & XIO_MAYCONVERT)) {
  55       Error("address with data processing not allowed here");
  56       return STAT_NORETRY;
  57    }
  58    xfd->common.flags |= XIO_DOESCONVERT;
  59
  60    strcpy(cp, "using "); cp = strchr(cp, '\0');
  61    if ((rw+1)&1) {
  62       strcpy(cp, "readline on stdin for reading"); cp = strchr(cp, '\0');
  63
  64       if ((rw+1)&2)
  65       strcpy(cp, " and ");  cp = strchr(cp, '\0');
  66    }
  67    if ((rw+1)&2) {
  68       strcpy(cp, "stdio for writing"); cp = strchr(cp, '\0');
  69    }
  70    Notice(msgbuf);
  71
  72    xfd->stream.fd = 0;  /* stdin */
  73    xfd->stream.howtoend = END_NONE;
  74    xfd->stream.dtype    = XIODATA_READLINE;
  75
  76 #if WITH_TERMIOS
  77    if (Isatty(xfd->stream.fd)) {
  78       if (Tcgetattr(xfd->stream.fd, &xfd->stream.savetty) < 0) {
  79          Warn2("cannot query current terminal settings on fd %d. %s",
  80                xfd->stream.fd, strerror(errno));
  81       } else {
  82          xfd->stream.ttyvalid = true;
  83       }
  84    }
  85 #endif /* WITH_TERMIOS */
  86
  87    if (applyopts_single(&xfd->stream, opts, PH_INIT) < 0)  return -1;
  88    applyopts(-1, opts, PH_INIT);
  89
  90    applyopts2(xfd->stream.fd, opts, PH_INIT, PH_FD);
  91
  92    Using_history();
  93    applyopts_offset(&xfd->stream, opts);
  94    retropt_bool(opts, OPT_NOPROMPT, &noprompt);
  95    if (!noprompt && !xfd->stream.para.readline.prompt) {
  96       xfd->stream.para.readline.dynbytes = READLINE_MAXPROMPT;
  97       xfd->stream.para.readline.dynprompt =
  98          Malloc(xfd->stream.para.readline.dynbytes+1);
  99       xfd->stream.para.readline.dynend =
 100          xfd->stream.para.readline.dynprompt;
 101    }
 102
 103 #if HAVE_REGEX_H
 104    retropt_string(opts, OPT_NOECHO, &noecho);
 105    if (noecho) {
 106       int errcode;
 107       char errbuf[128];
 108       if ((errcode = regcomp(&xfd->stream.para.readline.noecho, noecho,
 109                              REG_EXTENDED|REG_NOSUB))
 110           != 0) {
 111          regerror(errcode, &xfd->stream.para.readline.noecho,
 112                   errbuf, sizeof(errbuf));
 113          Error3("regcomp(%p, \"%s\", REG_EXTENDED|REG_NOSUB): %s",
 114                 &xfd->stream.para.readline.noecho, noecho, errbuf);
 115          return -1;
 116       }
 117       xfd->stream.para.readline.hasnoecho = true;
 118    }
 119 #endif /* HAVE_REGEX_H */
 120    if (xfd->stream.para.readline.history_file) {
 121       Read_history(xfd->stream.para.readline.history_file);
 122    }
 123 #if _WITH_TERMIOS
 124    xiotermios_clrflag(xfd->stream.fd, 3, ICANON);
 125    xiotermios_clrflag(xfd->stream.fd, 3, ECHO);
 126 #endif /* _WITH_TERMIOS */
 127    return _xio_openlate(&xfd->stream, opts);
 128 }
 129
 130
 131 ssize_t xioread_readline(struct single *pipe, void *buff, size_t bufsiz) {
 132    /*! indent */
 133    ssize_t bytes;
 134    char *line;
 135    int _errno;
 136
 137 #if HAVE_REGEX_H
 138       if (pipe->para.readline.dynprompt &&
 139           pipe->para.readline.hasnoecho &&
 140           !regexec(&pipe->para.readline.noecho,
 141                    pipe->para.readline.dynprompt, 0, NULL, 0)) {
 142 #if _WITH_TERMIOS
 143       /* under these conditions, we do not echo input, thus we circumvent
 144          readline */
 145          struct termios saveterm, setterm;
 146          *pipe->para.readline.dynend = '\0';
 147          Tcgetattr(pipe->fd, &saveterm);        /*! error */
 148          setterm = saveterm;
 149          setterm.c_lflag |= ICANON;
 150          Tcsetattr(pipe->fd, TCSANOW, &setterm);        /*!*/
 151 #endif /* _WITH_TERMIOS */
 152          do {
 153             bytes = Read(pipe->fd, buff, bufsiz);
 154          } while (bytes < 0 && errno == EINTR);
 155          if (bytes < 0) {
 156             _errno = errno;
 157             Error4("read(%d, %p, "F_Zu"): %s",
 158                    pipe->fd, buff, bufsiz, strerror(_errno));
 159             errno = _errno;
 160             return -1;
 161          }
 162 #if _WITH_TERMIOS
 163          setterm.c_lflag &= ~ICANON;
 164          Tcgetattr(pipe->fd, &setterm); /*! error */
 165          Tcsetattr(pipe->fd, TCSANOW, &saveterm);       /*!*/
 166 #endif /* _WITH_TERMIOS */
 167          pipe->para.readline.dynend = pipe->para.readline.dynprompt;
 168          /*Write(pipe->fd, "\n", 1);*/  /*!*/
 169          return bytes;
 170       }
 171 #endif /* HAVE_REGEX_H */
 172
 173 #if _WITH_TERMIOS
 174       xiotermios_setflag(pipe->fd, 3, ECHO);
 175 #endif /* _WITH_TERMIOS */
 176       if (pipe->para.readline.prompt || pipe->para.readline.dynprompt) {
 177          /* we must carriage return, because readline will first print the
 178             prompt */
 179          ssize_t writt;
 180          do {
 181             writt = Write(pipe->fd, "\r", 1);
 182          } while (writt < 0 && errno == EINTR);
 183          if (writt < 0) {
 184             Warn2("write(%d, \"\\r\", 1): %s",
 185                    pipe->fd, strerror(errno));
 186          } else if (writt < 1) {
 187             Warn1("write() only wrote "F_Zu" of 1 byte", writt);
 188          }
 189       }
 190
 191       if (pipe->para.readline.dynprompt) {
 192          *pipe->para.readline.dynend = '\0';
 193          line = Readline(pipe->para.readline.dynprompt);
 194          pipe->para.readline.dynend = pipe->para.readline.dynprompt;
 195       } else {
 196          line = Readline(pipe->para.readline.prompt);
 197       }
 198       /* GNU readline defines no error return */
 199       if (line == NULL) {
 200          return 0;      /* EOF */
 201       }
 202 #if _WITH_TERMIOS
 203       xiotermios_clrflag(pipe->fd, 3, ECHO);
 204 #endif /* _WITH_TERMIOS */
 205       Add_history(line);
 206       bytes = strlen(line);
 207       strncpy(buff, line, bufsiz);
 208       free(line);
 209       if ((size_t)bytes < bufsiz) {
 210          strcat(buff, "\n");  ++bytes;
 211       }
 212       return bytes;
 213 }
 214
 215 void xioscan_readline(struct single *pipe, const void *buff, size_t bytes) {
 216    if (pipe->dtype == XIODATA_READLINE && pipe->para.readline.dynprompt) {
 217       /* we save the last part of the output as possible prompt */
 218       const void *ptr = buff;
 219       const void *pcr = memrchr(buff, '\r', bytes);
 220       const void *plf = memrchr(buff, '\n', bytes);
 221       size_t len;
 222       if (bytes > pipe->para.readline.dynbytes) {
 223          ptr = (const char *)buff + bytes - pipe->para.readline.dynbytes;
 224       }
 225       if (pcr) {
 226          /* forget old prompt */
 227          pipe->para.readline.dynend = pipe->para.readline.dynprompt;
 228          /* new prompt starts here */
 229          ptr = (const char *)pcr+1;
 230       }
 231       if (plf && plf >= ptr) {
 232          /* forget old prompt */
 233          pipe->para.readline.dynend = pipe->para.readline.dynprompt;
 234          /* new prompt starts here */
 235          ptr = (const char *)plf+1;
 236       }
 237       len = (const char *)buff-(const char *)ptr+bytes;
 238       if (pipe->para.readline.dynend - pipe->para.readline.dynprompt + len >
 239           pipe->para.readline.dynbytes) {
 240          memmove(pipe->para.readline.dynprompt,
 241                  pipe->para.readline.dynend -
 242                     (pipe->para.readline.dynbytes - len),
 243                  pipe->para.readline.dynbytes - len);
 244          pipe->para.readline.dynend =
 245             pipe->para.readline.dynprompt + pipe->para.readline.dynbytes - len;
 246       }
 247       memcpy(pipe->para.readline.dynend, ptr, len);
 248       /*pipe->para.readline.dynend = pipe->para.readline.dynprompt + len;*/
 249       pipe->para.readline.dynend = pipe->para.readline.dynend + len;
 250    }
 251    return;
 252 }
 253
 254 #endif /* WITH_READLINE */