ysyx-workbench/npc/utils/sdb/console.cpp

// cpp-readline library
//
// @author zmij
// @date Nov 30, 2015

#include <console.hpp>

#include <algorithm>
#include <fstream>
#include <functional>
#include <iostream>
#include <iterator>
#include <sstream>
#include <unordered_map>

#include <cstdlib>
#include <cstring>
#include <readline/history.h>
#include <readline/readline.h>

namespace CppReadline {
namespace {

Console *currentConsole = nullptr;
HISTORY_STATE *emptyHistory = history_get_history_state();

} /* namespace  */

struct Console::Impl {
  using RegisteredCommands =
      std::unordered_map<std::string, Console::CommandFunction>;

  ::std::string greeting_;
  // These are hardcoded commands. They do not do anything and are catched manually in the executeCommand function.
  RegisteredCommands commands_;
  HISTORY_STATE *history_ = nullptr;

  Impl(::std::string const &greeting) : greeting_(greeting), commands_() {}
  ~Impl() { free(history_); }

  Impl(Impl const &) = delete;
  Impl(Impl &&) = delete;
  Impl &operator=(Impl const &) = delete;
  Impl &operator=(Impl &&) = delete;
};

// Here we set default commands, they do nothing since we quit with them
// Quitting behaviour is hardcoded in readLine()
Console::Console(std::string const &greeting) : pimpl_{new Impl{greeting}} {
  // Init readline basics
  rl_attempted_completion_function = &Console::getCommandCompletions;

  // These are default hardcoded commands.
  // Help command lists available commands.
  pimpl_->commands_["help"] = [this](const Arguments &) {
    auto commands = getRegisteredCommands();
    std::cout << "Available commands are:\n";
    for (auto &command : commands)
      std::cout << "\t" << command << "\n";
    return ReturnCode::Ok;
  };
  // Run command executes all commands in an external file.
  pimpl_->commands_["run"] = [this](const Arguments &input) {
    if (input.size() < 2) {
      std::cout << "Usage: " << input[0] << " script_filename\n";
      return 1;
    }
    return executeFile(input[1]);
  };
  // Quit and Exit simply terminate the console.
  pimpl_->commands_["quit"] = [this](const Arguments &) {
    return ReturnCode::Quit;
  };

  pimpl_->commands_["exit"] = [this](const Arguments &) {
    return ReturnCode::Quit;
  };
}

Console::~Console() = default;

void Console::registerCommand(const std::string &s, CommandFunction f) {
  pimpl_->commands_[s] = f;
}

void Console::removeCommands(const std::vector<std::string> sv) {
  for (auto const &s : sv) {
    pimpl_->commands_.erase(s);
  }
}

std::vector<std::string> Console::getRegisteredCommands() const {
  std::vector<std::string> allCommands;
  for (auto &pair : pimpl_->commands_)
    allCommands.push_back(pair.first);

  return allCommands;
}

void Console::saveState() {
  free(pimpl_->history_);
  pimpl_->history_ = history_get_history_state();
}

void Console::reserveConsole() {
  if (currentConsole == this)
    return;

  // Save state of other Console
  if (currentConsole)
    currentConsole->saveState();

  // Else we swap state
  if (!pimpl_->history_)
    history_set_history_state(emptyHistory);
  else
    history_set_history_state(pimpl_->history_);

  // Tell others we are using the console
  currentConsole = this;
}

void Console::setGreeting(const std::string &greeting) {
  pimpl_->greeting_ = greeting;
}

std::string Console::getGreeting() const { return pimpl_->greeting_; }

int Console::executeCommand(const std::string &command) {
  // Convert input to vector
  std::vector<std::string> inputs;
  {
    std::istringstream iss(command);
    std::copy(std::istream_iterator<std::string>(iss),
              std::istream_iterator<std::string>(), std::back_inserter(inputs));
  }

  if (inputs.size() == 0)
    return ReturnCode::Ok;

  Impl::RegisteredCommands::iterator it;
  if ((it = pimpl_->commands_.find(inputs[0])) != end(pimpl_->commands_)) {
    return static_cast<int>((it->second)(inputs));
  }

  std::cout << "Command '" << inputs[0] << "' not found.\n";
  return ReturnCode::Error;
}

int Console::executeFile(const std::string &filename) {
  std::ifstream input(filename);
  if (!input) {
    std::cout << "Could not find the specified file to execute.\n";
    return ReturnCode::Error;
  }
  std::string command;
  int counter = 0, result;

  while (std::getline(input, command)) {
    if (command[0] == '#')
      continue; // Ignore comments
    // Report what the Console is executing.
    std::cout << "[" << counter << "] " << command << '\n';
    if ((result = executeCommand(command)))
      return result;
    ++counter;
    std::cout << '\n';
  }

  // If we arrived successfully at the end, all is ok
  return ReturnCode::Ok;
}

int Console::readLine() {
  reserveConsole();

  char *buffer = readline(pimpl_->greeting_.c_str());
  if (!buffer) {
    std::cout
        << '\n'; // EOF doesn't put last endline so we put that so that it looks uniform.
    return ReturnCode::Quit;
  }

  // TODO: Maybe add commands to history only if succeeded?
  if (buffer[0] != '\0')
    add_history(buffer);

  std::string line(buffer);
  free(buffer);

  return executeCommand(line);
}

char **Console::getCommandCompletions(const char *text, int start, int) {
  char **completionList = nullptr;

  if (start == 0)
    completionList = rl_completion_matches(text, &Console::commandIterator);

  return completionList;
}

char *Console::commandIterator(const char *text, int state) {
  static Impl::RegisteredCommands::iterator it;
  if (!currentConsole)
    return nullptr;
  auto &commands = currentConsole->pimpl_->commands_;

  if (state == 0)
    it = begin(commands);

  while (it != end(commands)) {
    auto &command = it->first;
    ++it;
    if (command.find(text) != std::string::npos) {
      return strdup(command.c_str());
    }
  }
  return nullptr;
}
} // namespace CppReadline