Console/Readline.cc

   1 // $Id$
   2 //
   3 // Copyright (C) 2008
   4 // Fraunhofer Institute for Open Communication Systems (FOKUS)
   5 // Competence Center NETwork research (NET), St. Augustin, GERMANY
   6 //     Stefan Bund <g0dil@berlios.de>
   7 //
   8 // This program is free software; you can redistribute it and/or modify
   9 // it under the terms of the GNU General Public License as published by
  10 // the Free Software Foundation; either version 2 of the License, or
  11 // (at your option) any later version.
  12 //
  13 // This program is distributed in the hope that it will be useful,
  14 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  15 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16 // GNU General Public License for more details.
  17 //
  18 // You should have received a copy of the GNU General Public License
  19 // along with this program; if not, write to the
  20 // Free Software Foundation, Inc.,
  21 // 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  22
  23 /** \file
  24     \brief Readline non-inline non-template implementation */
  25
  26 #include "Readline.hh"
  27 //#include "Readline.ih"
  28
  29 // Custom includes
  30 #include <stdio.h>
  31 #include <readline/readline.h>
  32 #include <readline/history.h>
  33 #include <boost/algorithm/string/trim.hpp>
  34 #include <boost/algorithm/string/replace.hpp>
  35 #include "../Utils/membind.hh"
  36
  37 //#include "Readline.mpp"
  38 #define prefix_
  39 ///////////////////////////////cc.p////////////////////////////////////////
  40
  41 //
  42 // Readline integration is a bit awkward. There are several things to it:
  43 //
  44 //  - Readline uses global variables for all state. Therefore, we can use readline only for one
  45 //    console.
  46 //  - We need to make readline to read from the socket handle instead of some input stream. We can
  47 //    do this by setting a custom rl_getc_function.
  48 //  - We need to make readline to write to the NonblockingSocketOStream. This is possible in glibc
  49 //    by using a 'cookie stream'.
  50 //  - We need to correctly handle the terminal mode settings. Currently we unconditionally
  51 //    initialize the remote telnet by sending a fixed telnet option string and ignoring any otpions
  52 //    sent back to us.
  53 //  - We need to make sure, readline never uses stderr -> we must disable beeping
  54 //  - There are places, where readline calls read_key unconditionally even when NOT prompted by the
  55 //    callback that another key is available. One such place is completion. (The 'show all
  56 //    completions (y/n)?' question). For now, we disable completion support.
  57 //
  58
  59 ///////////////////////////////////////////////////////////////////////////
  60 // senf::console::detail::ReadlineClientReader
  61
  62 extern "C" {
  63     extern int readline_echoing_p;
  64     extern int _rl_bell_preference;
  65
  66     void _rl_erase_entire_line();
  67 }
  68
  69
  70 namespace {
  71
  72     int readline_getc_function(FILE *)
  73     {
  74         if (senf::console::detail::ReadlineClientReader::active())
  75             return senf::console::detail::ReadlineClientReader::instance().getc();
  76         else
  77             return -1;
  78     }
  79
  80     void readline_callback(char * input)
  81     {
  82         if (senf::console::detail::ReadlineClientReader::active()) {
  83             if (input)
  84                 return senf::console::detail::ReadlineClientReader::instance().callback(
  85                     std::string(input) );
  86             else // input == 0 -> EOF (or Ctrl-D)
  87                 senf::console::detail::ReadlineClientReader::instance().eof();
  88         }
  89     }
  90
  91     ssize_t readline_cookie_write_function(void * cookie, char const * buffer, size_t size)
  92     {
  93         if (senf::console::detail::ReadlineClientReader::active() && buffer)
  94             senf::console::detail::ReadlineClientReader::instance().write(
  95                 std::string(buffer, size));
  96         return size;
  97     }
  98
  99     void readline_prep_term(int meta)
 100     {
 101         readline_echoing_p = 1;
 102     }
 103
 104     void readline_deprep_term()
 105     {}
 106
 107     int restart_line(int count, int key)
 108     {
 109         rl_kill_full_line(count, key);
 110         rl_crlf();
 111         rl_forced_update_display();
 112         return 0;
 113     }
 114
 115 }
 116
 117 prefix_ senf::console::detail::ReadlineClientReader::ReadlineClientReader(Client & client)
 118     : ClientReader(client), ch_ (-1), skipChars_ (0),
 119       schedBinding_ ( client.handle(),
 120                       senf::membind(&ReadlineClientReader::charEvent, this),
 121                       Scheduler::EV_READ,
 122                       false ),
 123       terminate_ (false)
 124 {
 125     if (instance_ != 0)
 126         throw DuplicateReaderException();
 127     instance_ = this;
 128
 129     cookie_io_functions_t cookie_io = { 0, &readline_cookie_write_function, 0, 0 };
 130     rl_outstream = fopencookie(0, "a", cookie_io);
 131     if (rl_outstream == 0)
 132         SENF_THROW_SYSTEM_EXCEPTION("");
 133     if (setvbuf(rl_outstream, 0, _IONBF, BUFSIZ) < 0)
 134         SENF_THROW_SYSTEM_EXCEPTION("");
 135     rl_instream = rl_outstream;
 136     rl_terminal_name = "vt100";
 137     strncpy(nameBuffer_, client.name().c_str(), 128);
 138     nameBuffer_[127] = 0;
 139     rl_readline_name = nameBuffer_;
 140     rl_prep_term_function = &readline_prep_term;
 141     rl_deprep_term_function = &readline_deprep_term;
 142     rl_getc_function = &readline_getc_function;
 143     rl_bind_key('\t', &rl_insert);
 144     rl_bind_key('\x03', &restart_line);
 145     using_history();
 146
 147     // Don't ask me, where I found this ...
 148     static char options[] = { 0xFF, 0xFB, 0x01, // IAC WILL ECHO
 149                               0xFF, 0xFE, 0x22, // IAC DONT LINEMODE
 150                               0xFF, 0xFB, 0x03, // IAC WILL SGA
 151                               0x00 };
 152     handle().write(options, options+sizeof(options));
 153     handle().write(std::string("(readline support enabled)\r\n"));
 154
 155     strncpy(promptBuffer_, promptString().c_str(), 1024);
 156     promptBuffer_[1023] = 0;
 157     rl_callback_handler_install(promptBuffer_, &readline_callback);
 158
 159     _rl_bell_preference = 0; // Set this *after* the config file has been read
 160
 161     schedBinding_.enable();
 162 }
 163
 164 prefix_ senf::console::detail::ReadlineClientReader::~ReadlineClientReader()
 165 {
 166     rl_callback_handler_remove();
 167     fclose(rl_outstream);
 168     rl_outstream = 0;
 169     rl_instream = 0;
 170     instance_ = 0;
 171 }
 172
 173 prefix_ void senf::console::detail::ReadlineClientReader::callback(std::string line)
 174 {
 175     boost::trim(line);
 176     if (!line.empty())
 177         add_history(line.c_str());
 178     handleInput(line);
 179     stream() << std::flush;
 180     strncpy(promptBuffer_, promptString().c_str(), 1024);
 181     promptBuffer_[1023] = 0;
 182     rl_set_prompt(promptBuffer_);
 183 }
 184
 185 prefix_ void senf::console::detail::ReadlineClientReader::v_disablePrompt()
 186 {
 187     _rl_erase_entire_line();
 188 }
 189
 190 prefix_ void senf::console::detail::ReadlineClientReader::v_enablePrompt()
 191 {
 192     rl_forced_update_display();
 193 }
 194
 195 prefix_ void senf::console::detail::ReadlineClientReader::v_translate(std::string & data)
 196 {
 197     boost::replace_all(data, "\n", "\n\r");
 198     boost::replace_all(data, "\xff", "\xff\xff");
 199 }
 200
 201 prefix_ void senf::console::detail::ReadlineClientReader::charEvent(Scheduler::EventId event)
 202 {
 203     char ch;
 204     if (event != Scheduler::EV_READ || handle().read(&ch, &ch+1) <= &ch) {
 205         stopClient();
 206         return;
 207     }
 208     ch_ = static_cast<unsigned char>(ch);
 209
 210     if (skipChars_ > 0)
 211         --skipChars_;
 212     else if (ch_ == 0xff)
 213         skipChars_ = 2;
 214     else if (ch_ != 0)
 215         rl_callback_read_char();
 216
 217     if (terminate_)
 218         stopClient();
 219 }
 220
 221 senf::console::detail::ReadlineClientReader *
 222     senf::console::detail::ReadlineClientReader::instance_ (0);
 223
 224 ///////////////////////////////////////////////////////////////////////////
 225 // senf::console::detail::SafeReadlineClientReader
 226
 227 prefix_ void senf::console::detail::SafeReadlineClientReader::v_disablePrompt()
 228 {
 229     reader_->disablePrompt();
 230 }
 231
 232 prefix_ void senf::console::detail::SafeReadlineClientReader::v_enablePrompt()
 233 {
 234     reader_->enablePrompt();
 235 }
 236
 237 prefix_ void senf::console::detail::SafeReadlineClientReader::v_translate(std::string & data)
 238 {
 239     reader_->translate(data);
 240 }
 241
 242 ///////////////////////////////cc.e////////////////////////////////////////
 243 #undef prefix_
 244 //#include "Readline.mpp"
 245
 246 \f
 247 // Local Variables:
 248 // mode: c++
 249 // fill-column: 100
 250 // comment-column: 40
 251 // c-file-style: "senf"
 252 // indent-tabs-mode: nil
 253 // ispell-local-dictionary: "american"
 254 // compile-command: "scons -u test"
 255 // End: