utilwin.c

Go to the documentation of this file.

 
#include "config.h"
#include <stdbool.h>
#include <stddef.h>
#include "mutt/lib.h"
#include "core/lib.h"
#include "utilwin.h"
#include "color/lib.h"
#include "key/lib.h"
#include "module_data.h"
#include "mutt_curses.h"
#include "mutt_window.h"

#define UTILWIN_COLS 10

struct UtilWinData
{
  char *text; 
};

static int utilwin_recalc(struct MuttWindow *win)
{
  win->actions |= WA_REPAINT;
  mutt_debug(LL_DEBUG5, "recalc done, request WA_REPAINT\n");
  return 0;
}

static int utilwin_repaint(struct MuttWindow *win)
{
  struct UtilWinData *priv = win->wdata;
 
  mutt_curses_set_color_by_id(MT_COLOR_NORMAL);
 
  // Blank any extra rows above the bottom line
  for (int r = 0; r < (win->state.rows - 1); r++)
  {
    mutt_window_move(win, r, 0);
    mutt_window_clrtoeol(win);
  }
 
  int row = win->state.rows - 1;
  mutt_window_move(win, row, 0);
 
  if (priv->text)
    mutt_window_addstr(win, priv->text);
 
  mutt_window_clrtoeol(win);
 
  mutt_debug(LL_DEBUG5, "utilwin repaint done\n");
  return 0;
}

static void utilwin_wdata_free(struct MuttWindow *win, void **ptr)
{
  if (!ptr || !*ptr)
    return;
 
  struct UtilWinData *priv = *ptr;
  FREE(&priv->text);
  FREE(ptr);
}

static int utilwin_key_observer(struct NotifyCallback *nc)
{
  if (nc->event_type != NT_KEY)
    return 0;
  if (nc->event_subtype != NT_KEY_PROGRESS)
    return 0;
  if (!nc->global_data || !nc->event_data)
    return -1;
 
  struct MuttWindow *win = nc->global_data;
  struct EventKeyProgress *ev_k = nc->event_data;
 
  // Nothing to display — clear/hide the window
  if ((ev_k->count == 0) && (ev_k->key_len == 0))
  {
    utilwin_set_text(win, NULL);
    window_redraw(NULL);
    return 0;
  }
 
  struct Buffer *buf = buf_pool_get();
 
  if (ev_k->count > 0)
    buf_add_printf(buf, "%d", ev_k->count);
 
  for (int i = 0; i < ev_k->key_len; i++)
  {
    keymap_get_name(ev_k->keys[i], buf);
  }
 
  utilwin_set_text(win, buf_string(buf));
  buf_pool_release(&buf);
  window_redraw(NULL);
 
  return 0;
}

static int utilwin_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 = nc->global_data;
  struct EventWindow *ev_w = nc->event_data;
  if (ev_w->win != win)
    return 0;
 
  if (nc->event_subtype == NT_WINDOW_STATE)
  {
    win->actions |= WA_REPAINT;
    mutt_debug(LL_DEBUG5, "window state done, request WA_REPAINT\n");
  }
  else if (nc->event_subtype == NT_WINDOW_DELETE)
  {
    notify_observer_remove(NeoMutt->notify, utilwin_key_observer, win);
    notify_observer_remove(win->notify, utilwin_window_observer, win);
    mutt_debug(LL_DEBUG5, "window delete done\n");
  }
 
  return 0;
}

struct MuttWindow *utilwin_new(void)
{
  struct MuttWindow *win = mutt_window_new(WT_CUSTOM, MUTT_WIN_ORIENT_VERTICAL,
                                           MUTT_WIN_SIZE_FIXED, UTILWIN_COLS, 1);
 
  struct UtilWinData *priv = MUTT_MEM_CALLOC(1, struct UtilWinData);
 
  win->wdata = priv;
  win->wdata_free = utilwin_wdata_free;
  win->recalc = utilwin_recalc;
  win->repaint = utilwin_repaint;
 
  window_set_visible(win, false);
 
  struct GuiModuleData *mod_data = neomutt_get_module_data(NeoMutt, MODULE_ID_GUI);
  if (mod_data)
    mod_data->utility_window = win;
 
  notify_observer_add(NeoMutt->notify, NT_KEY, utilwin_key_observer, win);
  notify_observer_add(win->notify, NT_WINDOW, utilwin_window_observer, win);
 
  return win;
}

const char *utilwin_get_text(struct MuttWindow *win)
{
  if (!win)
  {
    struct GuiModuleData *mod_data = neomutt_get_module_data(NeoMutt, MODULE_ID_GUI);
    if (mod_data)
      win = mod_data->utility_window;
  }
  if (!win)
    return NULL;
 
  struct UtilWinData *priv = win->wdata;
  return priv->text;
}

void utilwin_set_text(struct MuttWindow *win, const char *text)
{
  if (!win)
  {
    struct GuiModuleData *mod_data = neomutt_get_module_data(NeoMutt, MODULE_ID_GUI);
    if (mod_data)
      win = mod_data->utility_window;
  }
  if (!win)
    return;
 
  struct UtilWinData *priv = win->wdata;
 
  if (!text || (*text == '\0'))
  {
    // Clear the old on-screen contents before hiding the window.
    // Hidden windows are skipped by repaint, so they can't erase themselves.
    mutt_window_clear(win);
    FREE(&priv->text);
    window_set_visible(win, false);
    mutt_window_reflow(NULL);
    return;
  }
 
  mutt_str_replace(&priv->text, text);
 
  window_set_visible(win, true);
  win->actions |= WA_RECALC;
  mutt_window_reflow(NULL);
}