helpbar.c

Go to the documentation of this file.

 
#include "config.h"
#include <stdbool.h>
#include "private.h"
#include "mutt/lib.h"
#include "config/lib.h"
#include "core/lib.h"
#include "gui/lib.h"
#include "gui/module_data.h"
#include "lib.h"
#include "color/lib.h"
#include "key/lib.h"

static bool make_help(const struct MenuDefinition *md, int op, const char *txt,
                      struct Buffer *buf)
{
  if (keymap_expand_key(km_find_func(md, op), buf))
  {
    buf_addch(buf, ':');
    buf_addstr(buf, txt);
    return true;
  }
 
  return false;
}

static void compile_help(const struct MenuDefinition *md,
                         const struct Mapping *items, struct Buffer *buf)
{
  for (int i = 0; items[i].name; i++)
  {
    if (!make_help(md, items[i].value, _(items[i].name), buf))
      continue;
 
    buf_addstr(buf, "  ");
  }
}

static int helpbar_recalc(struct MuttWindow *win)
{
  struct HelpbarWindowData *wdata = helpbar_wdata_get(win);
  if (!wdata)
    return 0;
 
  FREE(&wdata->help_str);
 
  struct MuttWindow *win_focus = window_get_focus();
  if (!win_focus)
    return 0;
 
  // Ascend the Window tree until we find help_data
  while (win_focus && !win_focus->help_data)
    win_focus = win_focus->parent;
 
  if (!win_focus)
    return 0;
 
  struct Buffer *helpstr = buf_pool_get();
  compile_help(win_focus->help_md, win_focus->help_data, helpstr);
 
  wdata->help_md = win_focus->help_md;
  wdata->help_data = win_focus->help_data;
  wdata->help_str = buf_strdup(helpstr);
  buf_pool_release(&helpstr);
 
  win->actions |= WA_REPAINT;
  mutt_debug(LL_DEBUG5, "recalc done, request WA_REPAINT\n");
  return 0;
}

static int helpbar_repaint(struct MuttWindow *win)
{
  struct HelpbarWindowData *wdata = helpbar_wdata_get(win);
  if (!wdata)
    return 0;
 
  mutt_curses_set_normal_backed_color_by_id(MT_COLOR_STATUS);
  mutt_window_move(win, 0, 0);
  mutt_paddstr(win, win->state.cols, wdata->help_str);
  mutt_curses_set_color_by_id(MT_COLOR_NORMAL);
 
  mutt_debug(LL_DEBUG5, "repaint done\n");
  return 0;
}

static int helpbar_binding_observer(struct NotifyCallback *nc)
{
  if (nc->event_type != NT_BINDING)
    return 0;
  if (!nc->global_data || !nc->event_data)
    return -1;
  if (nc->event_subtype >= NT_MACRO_ADD)
    return 0;
 
  struct MuttWindow *win_helpbar = nc->global_data;
  struct HelpbarWindowData *wdata = helpbar_wdata_get(win_helpbar);
  if (!wdata)
    return 0;
 
  struct EventBinding *ev_b = nc->event_data;
  if (wdata->help_md && (wdata->help_md != ev_b->menu))
    return 0;
 
  win_helpbar->actions |= WA_RECALC;
  mutt_debug(LL_DEBUG5, "binding done, request WA_RECALC\n");
  return 0;
}

static int helpbar_color_observer(struct NotifyCallback *nc)
{
  if (nc->event_type != NT_COLOR)
    return 0;
  if (!nc->global_data || !nc->event_data)
    return -1;
 
  struct EventColor *ev_c = nc->event_data;
 
  // MT_COLOR_MAX is sent on `uncolor *`
  if ((ev_c->cid != MT_COLOR_STATUS) && (ev_c->cid != MT_COLOR_NORMAL) &&
      (ev_c->cid != MT_COLOR_MAX))
  {
    return 0;
  }
 
  struct MuttWindow *win_helpbar = nc->global_data;
 
  win_helpbar->actions |= WA_REPAINT;
  mutt_debug(LL_DEBUG5, "color done, request WA_REPAINT\n");
  return 0;
}

static int helpbar_config_observer(struct NotifyCallback *nc)
{
  if (nc->event_type != NT_CONFIG)
    return 0;
  if (!nc->global_data || !nc->event_data)
    return -1;
 
  struct EventConfig *ev_c = nc->event_data;
  if (!mutt_str_equal(ev_c->name, "help"))
    return 0;
 
  struct MuttWindow *win_helpbar = nc->global_data;
  win_helpbar->state.visible = cs_subset_bool(NeoMutt->sub, "help");
 
  mutt_window_reflow(win_helpbar->parent);
  mutt_debug(LL_DEBUG5, "config done: '%s', request WA_REFLOW on parent\n", ev_c->name);
  return 0;
}

static int helpbar_window_observer(struct NotifyCallback *nc)
{
  if (nc->event_type != NT_WINDOW)
    return 0;
  if (!nc->global_data || !nc->event_data)
    return -1;
 
  struct MuttWindow *win_helpbar = nc->global_data;
 
  if (nc->event_subtype == NT_WINDOW_FOCUS)
  {
    if (!mutt_window_is_visible(win_helpbar))
      return 0;
 
    win_helpbar->actions |= WA_RECALC;
    mutt_debug(LL_DEBUG5, "window focus: request WA_RECALC\n");
    return 0;
  }
 
  // The next two notifications must be specifically for us
  struct EventWindow *ew = nc->event_data;
  if (ew->win != win_helpbar)
    return 0;
 
  if (nc->event_subtype == NT_WINDOW_STATE)
  {
    win_helpbar->actions |= WA_RECALC;
    mutt_debug(LL_DEBUG5, "window state: request WA_RECALC\n");
  }
  else if (nc->event_subtype == NT_WINDOW_DELETE)
  {
    mutt_color_observer_remove(helpbar_color_observer, win_helpbar);
    notify_observer_remove(NeoMutt->notify, helpbar_binding_observer, win_helpbar);
    notify_observer_remove(NeoMutt->sub->notify, helpbar_config_observer, win_helpbar);
    struct GuiModuleData *mod_data = neomutt_get_module_data(NeoMutt, MODULE_ID_GUI);
    if (mod_data && mod_data->root_window)
      notify_observer_remove(mod_data->root_window->notify,
                             helpbar_window_observer, win_helpbar);
    mutt_debug(LL_DEBUG5, "window delete done\n");
  }
 
  return 0;
}

struct MuttWindow *helpbar_new(void)
{
  struct MuttWindow *win = mutt_window_new(WT_HELP_BAR, MUTT_WIN_ORIENT_VERTICAL,
                                           MUTT_WIN_SIZE_FIXED,
                                           MUTT_WIN_SIZE_UNLIMITED, 1);
  win->state.visible = cs_subset_bool(NeoMutt->sub, "help");
 
  win->recalc = helpbar_recalc;
  win->repaint = helpbar_repaint;
 
  win->wdata = helpbar_wdata_new();
  win->wdata_free = helpbar_wdata_free;
 
  mutt_color_observer_add(helpbar_color_observer, win);
  notify_observer_add(NeoMutt->notify, NT_BINDING, helpbar_binding_observer, win);
  notify_observer_add(NeoMutt->sub->notify, NT_CONFIG, helpbar_config_observer, win);
  struct GuiModuleData *mod_data = neomutt_get_module_data(NeoMutt, MODULE_ID_GUI);
  notify_observer_add(mod_data->root_window->notify, NT_WINDOW, helpbar_window_observer, win);
  return win;
}