pager.c

Go to the documentation of this file.

 
#include "config.h"
#include <stdbool.h>
#include <stddef.h>
#include <sys/stat.h>
#include "mutt/lib.h"
#include "config/lib.h"
#include "core/lib.h"
#include "gui/lib.h"
#include "debug/lib.h"
#include "lib.h"
#include "color/lib.h"
#include "hooks/lib.h"
#include "index/lib.h"
#include "key/lib.h"
#include "display.h"
#include "private_data.h"

static int config_pager_index_lines(struct MuttWindow *win)
{
  if (!mutt_window_is_visible(win))
    return 0;
 
  struct MuttWindow *dlg = dialog_find(win);
  struct MuttWindow *panel_index = window_find_child(dlg, WT_INDEX);
  struct MuttWindow *win_index = window_find_child(panel_index, WT_MENU);
  if (!win_index)
    return -1;
 
  const short c_pager_index_lines = cs_subset_number(NeoMutt->sub, "pager_index_lines");
 
  if (c_pager_index_lines > 0)
  {
    win_index->req_rows = c_pager_index_lines;
    win_index->size = MUTT_WIN_SIZE_FIXED;
 
    panel_index->size = MUTT_WIN_SIZE_MINIMISE;
    panel_index->state.visible = true;
  }
  else
  {
    win_index->req_rows = MUTT_WIN_SIZE_UNLIMITED;
    win_index->size = MUTT_WIN_SIZE_MAXIMISE;
 
    panel_index->size = MUTT_WIN_SIZE_MAXIMISE;
    panel_index->state.visible = false;
  }
 
  mutt_window_reflow(dlg);
  mutt_debug(LL_DEBUG5, "config, request WA_REFLOW\n");
  return 0;
}

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

static int pager_repaint(struct MuttWindow *win)
{
  struct PagerPrivateData *priv = win->wdata;
  if (!priv || !priv->pview || !priv->pview->pdata)
    return 0;
 
  dump_pager(priv);
 
  /* Phase 1: Reflow the content if the window was resized or needs repopulating.
   * Reset all line metadata and re-display lines up to the current position. */
  const bool repopulate = (priv->cur_line > priv->lines_used);
  if ((priv->redraw & PAGER_REDRAW_FLOW) || repopulate)
  {
    priv->win_height = -1;
    for (int i = 0; i <= priv->top_line; i++)
      if (!priv->lines[i].cont_line)
        priv->win_height++;
    for (int i = 0; i < priv->lines_max; i++)
    {
      priv->lines[i].offset = 0;
      priv->lines[i].cid = -1;
      priv->lines[i].cont_line = false;
      priv->lines[i].syntax_arr_size = 0;
      priv->lines[i].search_arr_size = -1;
      priv->lines[i].quote = NULL;
 
      MUTT_MEM_REALLOC(&(priv->lines[i].syntax), 1, struct TextSyntax);
      priv->lines[i].syntax[0].attr_color = NULL;
      priv->lines[i].syntax[0].first = -1;
      priv->lines[i].syntax[0].last = -1;
 
      if (priv->search_compiled && priv->lines[i].search)
        FREE(&(priv->lines[i].search));
    }
 
    if (!repopulate)
    {
      priv->lines_used = 0;
      priv->top_line = 0;
    }
 
    int i = -1;
    int j = -1;
    const PagerFlags flags = priv->has_types | priv->search_flag |
                             (priv->pview->flags & MUTT_PAGER_NOWRAP) |
                             (priv->pview->flags & MUTT_PAGER_STRIPES);
 
    while (display_line(priv->fp, &priv->bytes_read, &priv->lines, ++i,
                        &priv->lines_used, &priv->lines_max, flags, &priv->quote_list,
                        &priv->q_level, &priv->force_redraw, &priv->search_re,
                        priv->pview->win_pager, &priv->ansi_list) == 0)
    {
      if (!priv->lines[i].cont_line && (++j == priv->win_height))
      {
        if (!repopulate)
          priv->top_line = i;
        if (!priv->search_flag)
          break;
      }
    }
  }
 
  /* Phase 2: Repaint visible lines from top_line downward.  Repeatedly
   * calls display_line() for each row in the pager window. */
  if ((priv->redraw & PAGER_REDRAW_PAGER) || (priv->top_line != priv->old_top_line))
  {
    do
    {
      mutt_window_move(priv->pview->win_pager, 0, 0);
      priv->cur_line = priv->top_line;
      priv->old_top_line = priv->top_line;
      priv->win_height = 0;
      priv->force_redraw = false;
 
      while ((priv->win_height < priv->pview->win_pager->state.rows) &&
             (priv->lines[priv->cur_line].offset <= priv->st.st_size - 1))
      {
        const PagerFlags flags = (priv->pview->flags & MUTT_DISPLAYFLAGS) |
                                 priv->hide_quoted | priv->search_flag |
                                 (priv->pview->flags & MUTT_PAGER_NOWRAP) |
                                 (priv->pview->flags & MUTT_PAGER_STRIPES);
 
        if (display_line(priv->fp, &priv->bytes_read, &priv->lines, priv->cur_line,
                         &priv->lines_used, &priv->lines_max, flags, &priv->quote_list,
                         &priv->q_level, &priv->force_redraw, &priv->search_re,
                         priv->pview->win_pager, &priv->ansi_list) > 0)
        {
          priv->win_height++;
        }
        priv->cur_line++;
        mutt_window_move(priv->pview->win_pager, priv->win_height, 0);
      }
    } while (priv->force_redraw);
 
    /* Fill remaining rows with tilde characters (like vi) */
    const bool c_tilde = cs_subset_bool(NeoMutt->sub, "tilde");
    mutt_curses_set_normal_backed_color_by_id(MT_COLOR_TILDE);
    while (priv->win_height < priv->pview->win_pager->state.rows)
    {
      mutt_window_clrtoeol(priv->pview->win_pager);
      if (c_tilde)
        mutt_window_addch(priv->pview->win_pager, '~');
      priv->win_height++;
      mutt_window_move(priv->pview->win_pager, priv->win_height, 0);
    }
    mutt_curses_set_color_by_id(MT_COLOR_NORMAL);
  }
 
  priv->redraw = PAGER_REDRAW_NONE;
  mutt_debug(LL_DEBUG5, "repaint done\n");
  return 0;
}

static int pager_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;
  struct MuttWindow *win_pager = nc->global_data;
  struct PagerPrivateData *priv = win_pager->wdata;
  if (!priv)
    return 0;
 
  // MT_COLOR_MAX is sent on `uncolor *`
  if (COLOR_QUOTED(ev_c->cid) || (ev_c->cid == MT_COLOR_MAX))
  {
    // rework quoted colours
    qstyle_recolor(priv->quote_list);
  }
 
  if (ev_c->cid == MT_COLOR_MAX)
  {
    for (size_t i = 0; i < priv->lines_max; i++)
    {
      FREE(&(priv->lines[i].syntax));
    }
    priv->lines_used = 0;
  }
  else if ((ev_c->cid == MT_COLOR_ATTACHMENT) || (ev_c->cid == MT_COLOR_ATTACH_HEADERS) ||
           (ev_c->cid == MT_COLOR_BODY) || (ev_c->cid == MT_COLOR_BOLD) ||
           (ev_c->cid == MT_COLOR_ERROR) || (ev_c->cid == MT_COLOR_HDRDEFAULT) ||
           (ev_c->cid == MT_COLOR_HEADER) || (ev_c->cid == MT_COLOR_ITALIC) ||
           (ev_c->cid == MT_COLOR_MARKERS) || (ev_c->cid == MT_COLOR_MESSAGE) ||
           (ev_c->cid == MT_COLOR_NORMAL) || (ev_c->cid == MT_COLOR_SEARCH) ||
           (ev_c->cid == MT_COLOR_SIGNATURE) || (ev_c->cid == MT_COLOR_STRIPE_EVEN) ||
           (ev_c->cid == MT_COLOR_STRIPE_ODD) || (ev_c->cid == MT_COLOR_TILDE) ||
           (ev_c->cid == MT_COLOR_UNDERLINE) || (ev_c->cid == MT_COLOR_WARNING))
  {
    notify_send(priv->notify, NT_PAGER, NT_PAGER_VIEW, priv);
  }
 
  mutt_debug(LL_DEBUG5, "color done\n");
  return 0;
}

static int pager_config_observer(struct NotifyCallback *nc)
{
  if (nc->event_type != NT_CONFIG)
    return 0;
  if (!nc->global_data || !nc->event_data)
    return -1;
 
  struct MuttWindow *win_pager = nc->global_data;
  struct MuttWindow *focus = window_get_focus();
  // Either the Pager isn't visible, or isn't active
  if (focus != win_pager)
    return 0;
 
  struct EventConfig *ev_c = nc->event_data;
  if (mutt_str_equal(ev_c->name, "pager_index_lines"))
  {
    config_pager_index_lines(win_pager);
    mutt_debug(LL_DEBUG5, "config done\n");
  }
  else if ((mutt_str_equal(ev_c->name, "allow_ansi")) ||
           (mutt_str_equal(ev_c->name, "markers")) ||
           (mutt_str_equal(ev_c->name, "smart_wrap")) ||
           (mutt_str_equal(ev_c->name, "smileys")) ||
           (mutt_str_equal(ev_c->name, "tilde")) ||
           (mutt_str_equal(ev_c->name, "toggle_quoted_show_levels")) ||
           (mutt_str_equal(ev_c->name, "wrap")))
  {
    struct PagerPrivateData *priv = win_pager->parent->wdata;
    if (!priv)
      return -1;
 
    notify_send(priv->notify, NT_PAGER, NT_PAGER_VIEW, priv);
  }
  else if (mutt_str_equal(ev_c->name, "pager"))
  {
    const char *const c_pager = pager_get_pager(NeoMutt->sub);
    if (c_pager)
    {
      // A message-hook has set $pager
      // Close the Pager and let the Index handle the message
      struct PagerPrivateData *priv = win_pager->parent->wdata;
      priv->loop = PAGER_LOOP_QUIT;
      mutt_push_macro_event(0, OP_DISPLAY_MESSAGE);
    }
  }
 
  return 0;
}

static int pager_index_observer(struct NotifyCallback *nc)
{
  if (nc->event_type != NT_INDEX)
    return 0;
  if (!nc->global_data)
    return -1;
 
  struct MuttWindow *win_pager = nc->global_data;
 
  struct PagerPrivateData *priv = win_pager->wdata;
  if (!priv)
    return 0;
 
  struct IndexSharedData *shared = nc->event_data;
 
  if (nc->event_subtype & NT_INDEX_MAILBOX)
  {
    win_pager->actions |= WA_RECALC;
    mutt_debug(LL_DEBUG5, "index done, request WA_RECALC\n");
    priv->loop = PAGER_LOOP_QUIT;
  }
  else if (nc->event_subtype & NT_INDEX_EMAIL)
  {
    win_pager->actions |= WA_RECALC;
    mutt_debug(LL_DEBUG5, "index done, request WA_RECALC\n");
    priv->pager_redraw = true;
    if (shared && shared->email && (priv->loop != PAGER_LOOP_QUIT))
    {
      priv->loop = PAGER_LOOP_RELOAD;
      exec_message_hook(shared->mailbox, shared->email, CMD_MESSAGE_HOOK);
    }
    else
    {
      priv->loop = PAGER_LOOP_QUIT;
      priv->rc = 0;
    }
  }
 
  return 0;
}

static int pager_pager_observer(struct NotifyCallback *nc)
{
  if (nc->event_type != NT_PAGER)
    return 0;
  if (!nc->global_data || !nc->event_data)
    return -1;
 
  struct MuttWindow *win_pager = nc->global_data;
 
  struct PagerPrivateData *priv = win_pager->wdata;
  if (!priv)
    return 0;
 
  pager_queue_redraw(priv, PAGER_REDRAW_PAGER);
  mutt_debug(LL_DEBUG5, "pager done\n");
  return 0;
}

static int pager_window_observer(struct NotifyCallback *nc)
{
  if (nc->event_type != NT_WINDOW)
    return 0;
  if (!nc->global_data || !nc->event_data)
    return -1;
  if (nc->event_subtype != NT_WINDOW_DELETE)
    return 0;
 
  struct MuttWindow *win_pager = nc->global_data;
  struct EventWindow *ev_w = nc->event_data;
  if (ev_w->win != win_pager)
    return 0;
 
  struct PagerPrivateData *priv = win_pager->wdata;
  if (!priv)
    return 0;
 
  struct MuttWindow *dlg = window_find_parent(win_pager, WT_DLG_INDEX);
  if (!dlg)
    dlg = window_find_parent(win_pager, WT_DLG_PAGER);
 
  struct IndexSharedData *shared = dlg->wdata;
 
  mutt_color_observer_remove(pager_color_observer, win_pager);
  notify_observer_remove(NeoMutt->sub->notify, pager_config_observer, win_pager);
  notify_observer_remove(shared->notify, pager_index_observer, win_pager);
  notify_observer_remove(priv->notify, pager_pager_observer, win_pager);
  notify_observer_remove(win_pager->notify, pager_window_observer, win_pager);
 
  mutt_debug(LL_DEBUG5, "window delete done\n");
 
  return 0;
}

struct MuttWindow *pager_window_new(struct IndexSharedData *shared,
                                    struct PagerPrivateData *priv)
{
  struct MuttWindow *win = mutt_window_new(WT_CUSTOM, MUTT_WIN_ORIENT_VERTICAL,
                                           MUTT_WIN_SIZE_MAXIMISE, MUTT_WIN_SIZE_UNLIMITED,
                                           MUTT_WIN_SIZE_UNLIMITED);
  win->wdata = priv;
  win->recalc = pager_recalc;
  win->repaint = pager_repaint;
 
  mutt_color_observer_add(pager_color_observer, win);
  notify_observer_add(NeoMutt->sub->notify, NT_CONFIG, pager_config_observer, win);
  notify_observer_add(shared->notify, NT_INDEX, pager_index_observer, win);
  notify_observer_add(priv->notify, NT_PAGER, pager_pager_observer, win);
  notify_observer_add(win->notify, NT_WINDOW, pager_window_observer, win);
 
  return win;
}