GUI display a file/email/help in a viewport with paging. More...

#include "config.h"
#include <stdbool.h>
#include <stdint.h>
#include <stdio.h>
#include "mutt/lib.h"

Include dependency graph for lib.h:

This graph shows which files directly or indirectly include this file:

Data Structures
struct	PagerData
	Data to be displayed by PagerView. More...

struct	PagerView
	Paged view into some data. More...

Macros
#define	MUTT_PAGER_NO_FLAGS 0
	No flags are set.

#define	MUTT_SHOWFLAT (1 << 0)
	Show characters (used for displaying help)

#define	MUTT_SHOWCOLOR (1 << 1)
	Show characters in color otherwise don't show characters.

#define	MUTT_HIDE (1 << 2)
	Don't show quoted text.

#define	MUTT_SEARCH (1 << 3)
	Resolve search patterns.

#define	MUTT_TYPES (1 << 4)
	Compute line's type.

#define	MUTT_SHOW (MUTT_SHOWCOLOR \| MUTT_SHOWFLAT)

#define	MUTT_PAGER_MARKER (1 << 5)
	Use markers if option is set.

#define	MUTT_PAGER_ATTACHMENT (1 << 6)
	Attachments may exist.

#define	MUTT_PAGER_NOWRAP (1 << 7)
	Format for term width, ignore $wrap.

#define	MUTT_PAGER_LOGS (1 << 8)
	Logview mode.

#define	MUTT_PAGER_BOTTOM (1 << 9)
	Start at the bottom.

#define	MUTT_PAGER_STRIPES (1 << 10)
	Striped highlighting.

#define	MUTT_PAGER_MESSAGE (MUTT_SHOWCOLOR \| MUTT_PAGER_MARKER)

#define	MUTT_DISPLAYFLAGS (MUTT_SHOW \| MUTT_PAGER_MARKER \| MUTT_PAGER_LOGS)

#define	NT_PAGER_NO_FLAGS 0
	No flags are set.

#define	NT_PAGER_DELETE (1 << 0)
	Pager Private Data is about to be freed.

#define	NT_PAGER_VIEW (1 << 1)
	Pager View has changed.

#define	PAGER_REDRAW_NO_FLAGS 0
	No flags are set.

#define	PAGER_REDRAW_PAGER (1 << 1)
	Redraw the pager.

#define	PAGER_REDRAW_FLOW (1 << 2)
	Reflow the pager.

Typedefs
typedef uint16_t	PagerFlags
	Flags for dlg_pager(), e.g. MUTT_SHOWFLAT.

typedef uint8_t	NotifyPager
	Flags, e.g. NT_PAGER_DELETE.

typedef uint8_t	PagerRedrawFlags
	Flags, e.g. PAGER_REDRAW_PAGER.

Enumerations
enum	PagerMode { PAGER_MODE_UNKNOWN = 0 , PAGER_MODE_EMAIL , PAGER_MODE_ATTACH , PAGER_MODE_ATTACH_E , PAGER_MODE_HELP , PAGER_MODE_OTHER , PAGER_MODE_MAX }
	Determine the behaviour of the Pager. More...

enum	PagerLoopMode { PAGER_LOOP_CONTINUE = -7 , PAGER_LOOP_QUIT = -6 , PAGER_LOOP_RELOAD = -5 }
	What the Pager Event Loop should do next. More...

Functions
int	dlg_pager (struct PagerView *pview)
	Display an email, attachment, or help, in a window -.

int	mutt_do_pager (struct PagerView pview, struct Email e)
	Display some page-able text to the user (help or attachment)

void	buf_strip_formatting (struct Buffer dest, const char src, bool strip_markers)
	Removes ANSI and backspace formatting.

struct MuttWindow *	ppanel_new (bool status_on_top, struct IndexSharedData *shared)
	Create the Windows for the Pager panel.

struct MuttWindow *	pager_window_new (struct IndexSharedData shared, struct PagerPrivateData priv)
	Create a new Pager Window (list of Emails)

int	mutt_display_message (struct MuttWindow win_index, struct IndexSharedData shared)
	Display a message in the pager.

int	external_pager (struct MailboxView mv, struct Email e, const char *command)
	Display a message in an external program.

void	pager_queue_redraw (struct PagerPrivateData *priv, PagerRedrawFlags redraw)
	Queue a request for a redraw.

bool	mutt_is_quote_line (char buf, regmatch_t pmatch)
	Is a line of message text a quote?

const char *	pager_get_pager (struct ConfigSubset *sub)
	Get the value of $pager.

void	mutt_clear_pager_position (void)

void	dump_text_syntax (struct TextSyntax *ts, int num)

void	dump_line (int i, struct Line *line)

Variables
int	BrailleRow
	Braille display: row to leave the cursor.

int	BrailleCol
	Braille display: column to leave the cursor.

Detailed Description

GUI display a file/email/help in a viewport with paging.

Authors

Richard Russon
Ihor Antonov

Copyright: This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.

Definition in file lib.h.

Macro Definition Documentation

◆ MUTT_PAGER_NO_FLAGS

#define MUTT_PAGER_NO_FLAGS 0

No flags are set.

Definition at line 60 of file lib.h.

◆ MUTT_SHOWFLAT

#define MUTT_SHOWFLAT (1 << 0)

Show characters (used for displaying help)

Definition at line 61 of file lib.h.

◆ MUTT_SHOWCOLOR

#define MUTT_SHOWCOLOR (1 << 1)

Show characters in color otherwise don't show characters.

Definition at line 62 of file lib.h.

◆ MUTT_HIDE

#define MUTT_HIDE (1 << 2)

Don't show quoted text.

Definition at line 63 of file lib.h.

◆ MUTT_SEARCH

#define MUTT_SEARCH (1 << 3)

Resolve search patterns.

Definition at line 64 of file lib.h.

◆ MUTT_TYPES

#define MUTT_TYPES (1 << 4)

Compute line's type.

Definition at line 65 of file lib.h.

◆ MUTT_SHOW

#define MUTT_SHOW (MUTT_SHOWCOLOR | MUTT_SHOWFLAT)

Definition at line 66 of file lib.h.

◆ MUTT_PAGER_MARKER

#define MUTT_PAGER_MARKER (1 << 5)

Use markers if option is set.

Definition at line 69 of file lib.h.

◆ MUTT_PAGER_ATTACHMENT

#define MUTT_PAGER_ATTACHMENT (1 << 6)

Attachments may exist.

Definition at line 70 of file lib.h.

◆ MUTT_PAGER_NOWRAP

#define MUTT_PAGER_NOWRAP (1 << 7)

Format for term width, ignore $wrap.

Definition at line 71 of file lib.h.

◆ MUTT_PAGER_LOGS

#define MUTT_PAGER_LOGS (1 << 8)

Logview mode.

Definition at line 72 of file lib.h.

◆ MUTT_PAGER_BOTTOM

#define MUTT_PAGER_BOTTOM (1 << 9)

Start at the bottom.

Definition at line 73 of file lib.h.

◆ MUTT_PAGER_STRIPES

#define MUTT_PAGER_STRIPES (1 << 10)

Striped highlighting.

Definition at line 74 of file lib.h.

◆ MUTT_PAGER_MESSAGE

#define MUTT_PAGER_MESSAGE (MUTT_SHOWCOLOR | MUTT_PAGER_MARKER)

Definition at line 75 of file lib.h.

◆ MUTT_DISPLAYFLAGS

#define MUTT_DISPLAYFLAGS (MUTT_SHOW | MUTT_PAGER_MARKER | MUTT_PAGER_LOGS)

Definition at line 77 of file lib.h.

◆ NT_PAGER_NO_FLAGS

#define NT_PAGER_NO_FLAGS 0

No flags are set.

Definition at line 183 of file lib.h.

◆ NT_PAGER_DELETE

#define NT_PAGER_DELETE (1 << 0)

Pager Private Data is about to be freed.

Definition at line 184 of file lib.h.

◆ NT_PAGER_VIEW

#define NT_PAGER_VIEW (1 << 1)

Pager View has changed.

Definition at line 185 of file lib.h.

◆ PAGER_REDRAW_NO_FLAGS

#define PAGER_REDRAW_NO_FLAGS 0

No flags are set.

Definition at line 188 of file lib.h.

◆ PAGER_REDRAW_PAGER

#define PAGER_REDRAW_PAGER (1 << 1)

Redraw the pager.

Definition at line 189 of file lib.h.

◆ PAGER_REDRAW_FLOW

#define PAGER_REDRAW_FLOW (1 << 2)

Reflow the pager.

Definition at line 190 of file lib.h.

Typedef Documentation

◆ PagerFlags

typedef uint16_t PagerFlags

Flags for dlg_pager(), e.g. MUTT_SHOWFLAT.

Definition at line 59 of file lib.h.

◆ NotifyPager

typedef uint8_t NotifyPager

Flags, e.g. NT_PAGER_DELETE.

Definition at line 182 of file lib.h.

◆ PagerRedrawFlags

typedef uint8_t PagerRedrawFlags

Flags, e.g. PAGER_REDRAW_PAGER.

Definition at line 187 of file lib.h.

Enumeration Type Documentation

◆ PagerMode

enum PagerMode

Determine the behaviour of the Pager.

Enumerator
PAGER_MODE_UNKNOWN	A default and invalid mode, should never be used.
PAGER_MODE_EMAIL	Pager is invoked via 1st path. The mime part is selected automatically.
PAGER_MODE_ATTACH	Pager is invoked via 2nd path. A user-selected attachment (mime part or a nested email) will be shown.
PAGER_MODE_ATTACH_E	A special case of PAGER_MODE_ATTACH - attachment is a full-blown email message.
PAGER_MODE_HELP	Pager is invoked via 3rd path to show help.
PAGER_MODE_OTHER	Pager is invoked via 3rd path. Non-email content is likely to be shown.
PAGER_MODE_MAX	Another invalid mode, should never be used.

Definition at line 132 of file lib.h.

{
  PAGER_MODE_UNKNOWN = 0, 
 
  PAGER_MODE_EMAIL,       
  PAGER_MODE_ATTACH,      
  PAGER_MODE_ATTACH_E,    
  PAGER_MODE_HELP,        
  PAGER_MODE_OTHER,       
 
  PAGER_MODE_MAX,         
};

◆ PagerLoopMode

enum PagerLoopMode

What the Pager Event Loop should do next.

Enumerator
PAGER_LOOP_CONTINUE	Stay in the Pager Event Loop.
PAGER_LOOP_QUIT	Quit the Pager.
PAGER_LOOP_RELOAD	Reload the Pager from scratch.

Definition at line 148 of file lib.h.

{
  PAGER_LOOP_CONTINUE = -7,  
  PAGER_LOOP_QUIT     = -6,  
  PAGER_LOOP_RELOAD   = -5,  
};

Function Documentation

◆ mutt_do_pager()

int mutt_do_pager	(	struct PagerView *	pview,
		struct Email *	e )

Display some page-able text to the user (help or attachment)

Parameters

pview	PagerView to construct Pager object
e	Email to use

Return values

0	Success
-1	Error

Definition at line 122 of file do_pager.c.

{
  ASSERT(pview);
  ASSERT(pview->pdata);
  ASSERT(pview->pdata->fname);
  ASSERT((pview->mode == PAGER_MODE_ATTACH) ||
         (pview->mode == PAGER_MODE_HELP) || (pview->mode == PAGER_MODE_OTHER));
 
  struct MuttWindow *dlg = mutt_window_new(WT_DLG_PAGER, MUTT_WIN_ORIENT_VERTICAL,
                                           MUTT_WIN_SIZE_MAXIMISE, MUTT_WIN_SIZE_UNLIMITED,
                                           MUTT_WIN_SIZE_UNLIMITED);
 
  struct IndexSharedData *shared = index_shared_data_new();
  shared->email = e;
 
  notify_set_parent(shared->notify, dlg->notify);
 
  dlg->wdata = shared;
  dlg->wdata_free = index_shared_data_free;
 
  const bool c_status_on_top = cs_subset_bool(NeoMutt->sub, "status_on_top");
  struct MuttWindow *panel_pager = ppanel_new(c_status_on_top, shared);
  dlg->focus = panel_pager;
  mutt_window_add_child(dlg, panel_pager);
 
  notify_observer_add(NeoMutt->sub->notify, NT_CONFIG, dopager_config_observer, dlg);
  notify_observer_add(dlg->notify, NT_WINDOW, dopager_window_observer, dlg);
  dialog_push(dlg);
 
  pview->win_index = NULL;
  pview->win_pbar = window_find_child(panel_pager, WT_STATUS_BAR);
  pview->win_pager = window_find_child(panel_pager, WT_CUSTOM);
 
  int rc;
 
  const char *const c_pager = pager_get_pager(NeoMutt->sub);
  if (c_pager)
  {
    struct Buffer *cmd = buf_pool_get();
 
    mutt_endwin();
    buf_file_expand_fmt_quote(cmd, c_pager, pview->pdata->fname);
    if (mutt_system(buf_string(cmd)) == -1)
    {
      mutt_error(_("Error running \"%s\""), buf_string(cmd));
      rc = -1;
    }
    else
    {
      rc = 0;
    }
    mutt_file_unlink(pview->pdata->fname);
    buf_pool_release(&cmd);
  }
  else
  {
    rc = dlg_pager(pview);
  }
 
  dialog_pop();
  mutt_window_free(&dlg);
  return rc;
}

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buf_strip_formatting()

void buf_strip_formatting	(	struct Buffer *	dest,
		const char *	src,
		bool	strip_markers )

Removes ANSI and backspace formatting.

Parameters

dest	Buffer for the result
src	String to strip
strip_markers	Remove

Removes ANSI and backspace formatting, and optionally markers. This is separated out so that it can be used both by the pager and the autoview handler.

This logic is pulled from the pager fill_buffer() function, for use in stripping reply-quoted autoview output of ansi sequences.

Definition at line 730 of file display.c.

{
  const char *s = src;
 
  buf_reset(dest);
 
  if (!s)
    return;
 
  while (s[0] != '\0')
  {
    if ((s[0] == '\010') && (s > src))
    {
      if (s[1] == '_') /* underline */
      {
        s += 2;
      }
      else if (s[1] && buf_len(dest)) /* bold or overstrike */
      {
        dest->dptr--;
        buf_addch(dest, s[1]);
        s += 2;
      }
      else /* ^H */
      {
        buf_addch(dest, *s++);
      }
      continue;
    }
 
    int len = ansi_color_seq_length(s);
    if (len > 0)
    {
      s += len;
    }
    else if (strip_markers && (s[0] == '\033') && (s[1] == ']') &&
             ((check_attachment_marker(s) == 0) || (check_protected_header_marker(s) == 0)))
    {
      mutt_debug(LL_DEBUG2, "Seen attachment marker\n");
      while (*s++ != '\a')
        ; /* skip pseudo-ANSI sequence */
    }
    else
    {
      buf_addch(dest, *s++);
    }
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ppanel_new()

struct MuttWindow * ppanel_new	(	bool	status_on_top,
		struct IndexSharedData *	shared )

Create the Windows for the Pager panel.

Parameters

status_on_top	true, if the Pager bar should be on top
shared	Shared Index data

Return values

ptr	New Pager Panel

Definition at line 133 of file ppanel.c.

{
  struct MuttWindow *panel_pager = mutt_window_new(WT_PAGER, MUTT_WIN_ORIENT_VERTICAL,
                                                   MUTT_WIN_SIZE_MAXIMISE, MUTT_WIN_SIZE_UNLIMITED,
                                                   MUTT_WIN_SIZE_UNLIMITED);
  panel_pager->state.visible = false; // The Pager and Pager Bar are initially hidden
 
  struct PagerPrivateData *priv = pager_private_data_new();
  panel_pager->wdata = priv;
  panel_pager->wdata_free = pager_private_data_free;
 
  struct MuttWindow *win_pager = pager_window_new(shared, priv);
  panel_pager->focus = win_pager;
 
  struct MuttWindow *win_pbar = pbar_new(shared, priv);
  if (status_on_top)
  {
    mutt_window_add_child(panel_pager, win_pbar);
    mutt_window_add_child(panel_pager, win_pager);
  }
  else
  {
    mutt_window_add_child(panel_pager, win_pager);
    mutt_window_add_child(panel_pager, win_pbar);
  }
 
  notify_observer_add(NeoMutt->sub->notify, NT_CONFIG, ppanel_config_observer, panel_pager);
  notify_observer_add(panel_pager->notify, NT_WINDOW, ppanel_window_observer, panel_pager);
 
  return panel_pager;
}

Here is the call graph for this function:

Here is the caller graph for this function:

◆ pager_window_new()

struct MuttWindow * pager_window_new	(	struct IndexSharedData *	shared,
		struct PagerPrivateData *	priv )

Create a new Pager Window (list of Emails)

Parameters

shared	Shared Index Data
priv	Private Pager Data

Return values

ptr	New Window

Definition at line 429 of file pager.c.

{
  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;
}

Here is the call graph for this function:

Here is the caller graph for this function:

◆ mutt_display_message()

int mutt_display_message	(	struct MuttWindow *	win_index,
		struct IndexSharedData *	shared )

Display a message in the pager.

Parameters

win_index	Index Window
shared	Shared Index data

Return values

0	Success
-1	Error

Definition at line 446 of file message.c.

{
  struct MuttWindow *dlg = dialog_find(win_index);
  struct MuttWindow *win_pager = window_find_child(dlg, WT_CUSTOM);
  struct MuttWindow *win_pbar = window_find_child(dlg, WT_STATUS_BAR);
  struct Buffer *tempfile = buf_pool_get();
  struct Message *msg = NULL;
 
  squash_index_panel(shared->mailbox, win_index, win_pager);
 
  int rc = PAGER_LOOP_QUIT;
  do
  {
    msg = mx_msg_open(shared->mailbox, shared->email);
    if (!msg)
      break;
 
    CopyMessageFlags cmflags = MUTT_CM_DECODE | MUTT_CM_DISPLAY | MUTT_CM_CHARCONV;
 
    buf_reset(tempfile);
    // win_pager might not be visible and have a size yet, so use win_index
    rc = email_to_file(msg, tempfile, shared->mailbox, shared->email, NULL,
                       win_index->state.cols, &cmflags);
    if (rc < 0)
      break;
 
    notify_crypto(shared->email, msg, cmflags);
 
    /* Invoke the built-in pager */
    struct PagerData pdata = { 0 };
    struct PagerView pview = { &pdata };
 
    pdata.fp = msg->fp;
    pdata.fname = buf_string(tempfile);
 
    pview.mode = PAGER_MODE_EMAIL;
    pview.banner = NULL;
    pview.flags = MUTT_PAGER_MESSAGE |
                  (shared->email->body->nowrap ? MUTT_PAGER_NOWRAP : 0);
    pview.win_index = win_index;
    pview.win_pbar = win_pbar;
    pview.win_pager = win_pager;
 
    rc = dlg_pager(&pview);
    mx_msg_close(shared->mailbox, &msg);
  } while (rc == PAGER_LOOP_RELOAD);
 
  expand_index_panel(win_index, win_pager);
 
  mx_msg_close(shared->mailbox, &msg);
  buf_pool_release(&tempfile);
  return rc;
}

Here is the call graph for this function:

Here is the caller graph for this function:

◆ external_pager()

int external_pager	(	struct MailboxView *	mv,
		struct Email *	e,
		const char *	command )

Display a message in an external program.

Parameters

mv	Mailbox view
e	Email to display
command	External command to run

Return values

0	Success
-1	Error

Definition at line 299 of file message.c.

{
  if (!mv || !mv->mailbox)
    return -1;
 
  struct Mailbox *m = mv->mailbox;
  struct Message *msg = mx_msg_open(m, e);
  if (!msg)
    return -1;
 
  struct Buffer *buf = buf_pool_get();
  const struct Expando *c_pager_format = cs_subset_expando(NeoMutt->sub, "pager_format");
  const int screen_width = RootWindow->state.cols;
  mutt_make_string(buf, screen_width, c_pager_format, m, -1, e,
                   MUTT_FORMAT_NO_FLAGS, _(ExtPagerProgress));
 
  struct Buffer *tempfile = buf_pool_get();
 
  CopyMessageFlags cmflags = MUTT_CM_DECODE | MUTT_CM_DISPLAY | MUTT_CM_CHARCONV;
  int rc = email_to_file(msg, tempfile, m, e, buf_string(buf), screen_width, &cmflags);
  if (rc < 0)
    goto cleanup;
 
  mutt_endwin();
 
  struct Buffer *cmd = buf_pool_get();
  buf_printf(cmd, "%s %s", command, buf_string(tempfile));
  int r = mutt_system(buf_string(cmd));
  if (r == -1)
    mutt_error(_("Error running \"%s\""), buf_string(cmd));
  unlink(buf_string(tempfile));
  buf_pool_release(&cmd);
 
  if (OptGui)
    keypad(stdscr, true);
  if (r != -1)
    mutt_set_flag(m, e, MUTT_READ, true, true);
  const bool c_prompt_after = cs_subset_bool(NeoMutt->sub, "prompt_after");
  if ((r != -1) && c_prompt_after)
  {
    mutt_unget_ch(mutt_any_key_to_continue(_("Command: ")));
    rc = km_dokey(MENU_PAGER, GETCH_NO_FLAGS);
  }
  else
  {
    rc = 0;
  }
 
cleanup:
  buf_pool_release(&buf);
  mx_msg_close(m, &msg);
  buf_pool_release(&tempfile);
  return rc;
}

Here is the call graph for this function:

Here is the caller graph for this function:

◆ pager_queue_redraw()

void pager_queue_redraw	(	struct PagerPrivateData *	priv,
		PagerRedrawFlags	redraw )

Queue a request for a redraw.

Parameters

priv	Private Pager data
redraw	Item to redraw, e.g. PAGER_REDRAW_PAGER

Definition at line 128 of file dlg_pager.c.

{
  priv->redraw |= redraw;
 
  if (priv->pview && priv->pview->win_pager)
    priv->pview->win_pager->actions |= WA_RECALC;
}

Here is the caller graph for this function:

◆ mutt_is_quote_line()

bool mutt_is_quote_line	(	char *	line,
		regmatch_t *	pmatch )

Is a line of message text a quote?

Parameters

[in]	line	Line to test
[out]	pmatch	Regex sub-matches

Return values

true	Line is quoted

Checks if line matches the $quote_regex and doesn't match $smileys. This is used by the pager for calling qstyle_classify.

Definition at line 322 of file display.c.

{
  bool is_quote = false;
  const struct Regex *c_smileys = cs_subset_regex(NeoMutt->sub, "smileys");
  regmatch_t pmatch_internal[1] = { 0 };
 
  if (!pmatch)
    pmatch = pmatch_internal;
 
  const struct Regex *c_quote_regex = cs_subset_regex(NeoMutt->sub, "quote_regex");
  if (mutt_regex_capture(c_quote_regex, line, 1, pmatch))
  {
    regmatch_t smatch[1] = { 0 };
    if (mutt_regex_capture(c_smileys, line, 1, smatch))
    {
      if (smatch[0].rm_so > 0)
      {
        char c = line[smatch[0].rm_so];
        line[smatch[0].rm_so] = 0;
 
        if (mutt_regex_capture(c_quote_regex, line, 1, pmatch))
          is_quote = true;
 
        line[smatch[0].rm_so] = c;
      }
    }
    else
    {
      is_quote = true;
    }
  }
 
  return is_quote;
}

Here is the call graph for this function:

Here is the caller graph for this function:

◆ pager_get_pager()

const char * pager_get_pager ( struct ConfigSubset * sub )

Get the value of $pager.

Parameters

sub	Config Subset

Return values

str	External command to use
NULL	The internal pager will be used

Note: If $pager has the magic value of "builtin", NULL will be returned

Definition at line 111 of file config.c.

{
  const char *c_pager = cs_subset_string(sub, "pager");
  if (!c_pager || mutt_str_equal(c_pager, "builtin"))
    return NULL;
 
  return c_pager;
}

Here is the call graph for this function:

Here is the caller graph for this function:

◆ mutt_clear_pager_position()

void mutt_clear_pager_position ( void )

◆ dump_text_syntax()

void dump_text_syntax	(	struct TextSyntax *	ts,
		int	num )

Definition at line 64 of file pager.c.

{
  if (!ts || (num == 0))
    return;
 
  for (int i = 0; i < num; i++)
  {
    int index = -1;
    const char *swatch = "";
    if (ts[i].attr_color)
    {
      struct CursesColor *cc = ts[i].attr_color->curses_color;
      if (cc)
      {
        index = cc->index;
        swatch = color_log_color(cc->fg, cc->bg);
      }
    }
    mutt_debug(LL_DEBUG1, "\t\t(%d-%d) %d %s\n", ts[i].first, ts[i].last - 1, index, swatch);
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

◆ dump_line()

void dump_line	(	int	i,
		struct Line *	line )

Definition at line 86 of file pager.c.

{
  struct Buffer *buf = buf_pool_get();
 
  buf_add_printf(buf, "%d [+%ld]", i, line->offset);
 
  if ((line->cid > 0) && (line->cid != MT_COLOR_NORMAL))
  {
    const char *swatch = "";
    struct AttrColor *ac = simple_color_get(line->cid);
    if (ac && ac->curses_color)
    {
      struct CursesColor *cc = ac->curses_color;
      swatch = color_log_color(cc->fg, cc->bg);
    }
 
    buf_add_printf(buf, " %s (%d) %s", name_color_id(line->cid), line->cid, swatch);
  }
  mutt_debug(LL_DEBUG1, "%s\n", buf_string(buf));
 
  if (line->cont_line || line->cont_header)
  {
    mutt_debug(LL_DEBUG1, "\tcont: %s%s\n", line->cont_line ? "\033[1;32mL\033[0m" : "-",
               line->cont_header ? "\033[1;32mH\033[0m" : "-");
  }
 
  if (line->syntax_arr_size > 0)
  {
    mutt_debug(LL_DEBUG1, "\tsyntax: %d %p\n", line->syntax_arr_size,
               (void *) line->syntax);
    dump_text_syntax(line->syntax, line->syntax_arr_size);
  }
  if (line->search_arr_size > 0)
  {
    mutt_debug(LL_DEBUG1, "\t\033[1;36msearch\033[0m: %d %p\n",
               line->search_arr_size, (void *) line->search);
    dump_text_syntax(line->search, line->search_arr_size);
  }
 
  buf_pool_release(&buf);
}

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

◆ BrailleRow

int BrailleRow

extern

Braille display: row to leave the cursor.

Definition at line 68 of file dlg_pager.c.

◆ BrailleCol

int BrailleCol

extern

Braille display: column to leave the cursor.

Definition at line 70 of file dlg_pager.c.

Data Structures

Macros

Typedefs

Enumerations

Functions

Variables

Detailed Description

Macro Definition Documentation

◆ MUTT_PAGER_NO_FLAGS

◆ MUTT_SHOWFLAT

◆ MUTT_SHOWCOLOR

◆ MUTT_HIDE

◆ MUTT_SEARCH

◆ MUTT_TYPES

◆ MUTT_SHOW

◆ MUTT_PAGER_MARKER

◆ MUTT_PAGER_ATTACHMENT

◆ MUTT_PAGER_NOWRAP

◆ MUTT_PAGER_LOGS

◆ MUTT_PAGER_BOTTOM

◆ MUTT_PAGER_STRIPES

◆ MUTT_PAGER_MESSAGE

◆ MUTT_DISPLAYFLAGS

◆ NT_PAGER_NO_FLAGS

◆ NT_PAGER_DELETE

◆ NT_PAGER_VIEW

◆ PAGER_REDRAW_NO_FLAGS

◆ PAGER_REDRAW_PAGER

◆ PAGER_REDRAW_FLOW

Typedef Documentation

◆ PagerFlags

◆ NotifyPager

◆ PagerRedrawFlags

Enumeration Type Documentation

◆ PagerMode

◆ PagerLoopMode

Function Documentation

◆ mutt_do_pager()

◆ buf_strip_formatting()

◆ ppanel_new()

◆ pager_window_new()

◆ mutt_display_message()

◆ external_pager()

◆ pager_queue_redraw()

◆ mutt_is_quote_line()

◆ pager_get_pager()

◆ mutt_clear_pager_position()

◆ dump_text_syntax()

◆ dump_line()

Variable Documentation

◆ BrailleRow

◆ BrailleCol