help_panel.cpp

Go to the documentation of this file.

#include <log_view/panels/help_panel.h>

#include <cmath>
#include <log_view/utils.h>

namespace log_view {

// TODO handle case where terminal is too small

// TODO support show/hide timestamps

HelpPanel::HelpPanel(int height, int width, int y, int x) :
  PanelInterface(height, width, y, x),
  keys_({
    {2, "CTRL-c", "Exit log viewer"},
    {3, "CTRL-h", "Show/hide this help screen"},
    {5, "F1", "Show/hide debug level"},
    {6, "F2", "Show/hide info level"},
    {7, "F3", "Show/hide warning level"},
    {8, "F4", "Show/hide error level"},
    {9, "F5", "Show/hide fatal level"},
    {10, "F7", "Enable/disable node filter"},
    {11, "CTRL-a", "Select all"},
    {12, "CTRL-i", "Invert node selection"},
    {13, "CTRL-n", "Show/hide node selection"},
    {14, "CTRL-s", "Search for matching string"},
    {15, "CTRL-x", "Clear search"},
    {16, "Backspace", "Prev match"},
    {17, "Enter", "Next match"},
    {18, "CTRL-e", "Enable/disable text exclude filter"},
    {19, "CTRL-f", "Enable/disable text include filter"}})
{
  for (const auto& key: keys_) {
    longest_key_ = std::max(longest_key_, key.key.length());
  }

  for (const auto& key: keys_) {
    longest_line_ = std::max(longest_line_, longest_key_ + 11 + key.description.length());
  }
}

void HelpPanel::refresh() {
  box(window_, 0, 0);
  mvwprintw(window_,  0, width_ / 2 - 3, " help ");
  for (const auto& key: keys_) {
    printKeybinding(key);
  }
}

void HelpPanel::resize(int height, int width, int y, int x) {
  int w = width;
  if (w > longest_line_) {
    w = longest_line_;
    x += (width - w) / 2;
  }
  PanelInterface::resize(height, w, y, x);
}

bool HelpPanel::handleKey(int key) {
  if (hidden()) {
    return false;
  }

  if (key == ctrl('h')) {
      hide(visible());
  }
  else if (key == KEY_RESIZE || key == ctrl('q') || key == ctrl('c')) {
    return false;
  }

  return true;
}

void HelpPanel::printKeybinding(const HelpText& help_text) {
    mvwprintw(window_,  help_text.line, 3, help_text.key.c_str());

    int max_size = std::max(0, width() - (static_cast<int>(longest_key_) + 10));
    auto desc = help_text.description;
    if (desc.size() > max_size) {
      desc.resize(max_size);
    }
    mvwprintw(window_,  help_text.line, longest_key_ + 8, desc.c_str());

    int line_start = help_text.key.length() + 4;
    int line_end = longest_key_ + 7;

    wattron(window_, COLOR_PAIR(CP_GREY));
    mvwhline(window_, help_text.line, line_start, 0, line_end - line_start);
    wattroff(window_, COLOR_PAIR(CP_GREY));
}

} // namespace log_view