functions.c File Reference

Pager functions. More...

#include "config.h"
#include <inttypes.h>
#include <stdbool.h>
#include <stdio.h>
#include <sys/stat.h>
#include "mutt/lib.h"
#include "config/lib.h"
#include "email/lib.h"
#include "core/lib.h"
#include "gui/lib.h"
#include "mutt.h"
#include "functions.h"
#include "lib.h"
#include "attach/lib.h"
#include "browser/lib.h"
#include "color/lib.h"
#include "editor/lib.h"
#include "history/lib.h"
#include "index/lib.h"
#include "key/lib.h"
#include "menu/lib.h"
#include "pattern/lib.h"
#include "sidebar/lib.h"
#include "display.h"
#include "module_data.h"
#include "muttlib.h"
#include "private_data.h"

Include dependency graph for functions.c:

Go to the source code of this file.

Functions
static int	op_pager_search_next (struct PagerFunctionData *fdata, const struct KeyEvent *event)
	Search for next match - Implements pager_function_t -.
void	pager_init_keys (struct NeoMutt *n, struct SubMenu *sm_generic)
	Initialise the Pager Keybindings - Implements ::init_keys_api.
static bool	assert_pager_mode (bool test)
	Check that pager is in correct mode.
static int	up_n_lines (int nlines, struct Line *info, int cur, bool hiding)
	Reposition the pager's view up by n lines.
static int	down_n_lines (int nlines, struct Line *info, int cur, int max, bool hiding)
	Reposition the pager's view down by n lines.
bool	jump_to_bottom (struct PagerPrivateData *priv, struct PagerView *pview)
	Make sure the bottom line is displayed.
static int	op_first_entry (struct PagerFunctionData *fdata, const struct KeyEvent *event)
	Move to the first entry - Implements pager_function_t -.
static int	op_last_entry (struct PagerFunctionData *fdata, const struct KeyEvent *event)
	Move to the last entry - Implements pager_function_t -.
static int	op_pager_half_down (struct PagerFunctionData *fdata, const struct KeyEvent *event)
	Scroll down 1/2 page - Implements pager_function_t -.
static int	op_pager_half_up (struct PagerFunctionData *fdata, const struct KeyEvent *event)
	Scroll up 1/2 page - Implements pager_function_t -.
static int	op_pager_hide_quoted (struct PagerFunctionData *fdata, const struct KeyEvent *event)
	Toggle display of quoted text - Implements pager_function_t -.
static int	op_pager_next_line (struct PagerFunctionData *fdata, const struct KeyEvent *event)
	Scroll down one line - Implements pager_function_t -.
static int	op_pager_next_page (struct PagerFunctionData *fdata, const struct KeyEvent *event)
	Move to the next page - Implements pager_function_t -.
static int	op_pager_prev_line (struct PagerFunctionData *fdata, const struct KeyEvent *event)
	Scroll up one line - Implements pager_function_t -.
static int	op_pager_prev_page (struct PagerFunctionData *fdata, const struct KeyEvent *event)
	Move to the previous page - Implements pager_function_t -.
static int	op_pager_search (struct PagerFunctionData *fdata, const struct KeyEvent *event)
	Search for a regular expression - Implements pager_function_t -.
static int	op_pager_skip_headers (struct PagerFunctionData *fdata, const struct KeyEvent *event)
	Jump to first line after headers - Implements pager_function_t -.
static int	pager_skip_quoted_once (struct PagerPrivateData *priv, struct PagerFunctionData *fdata)
	Skip to next unquoted block.
static int	op_pager_skip_quoted (struct PagerFunctionData *fdata, const struct KeyEvent *event)
	Skip beyond quoted text - Implements pager_function_t -.
static int	op_exit (struct PagerFunctionData *fdata, const struct KeyEvent *event)
	Exit this menu - Implements pager_function_t -.
static int	op_quit (struct PagerFunctionData *fdata, const struct KeyEvent *event)
	Save changes to mailbox and quit - Implements pager_function_t -.
static int	op_help (struct PagerFunctionData *fdata, const struct KeyEvent *event)
	Help screen - Implements pager_function_t -.
static int	op_save (struct PagerFunctionData *fdata, const struct KeyEvent *event)
	Save the Pager text - Implements pager_function_t -.
static int	op_search_toggle (struct PagerFunctionData *fdata, const struct KeyEvent *event)
	Toggle search pattern coloring - Implements pager_function_t -.
static int	op_view_attachments (struct PagerFunctionData *fdata, const struct KeyEvent *event)
	Show MIME attachments - Implements pager_function_t -.
static int	op_ignore (struct PagerFunctionData *fdata, const struct KeyEvent *event)
	Ignore this function - Implements pager_function_t -.
int	pager_function_dispatcher (struct MuttWindow *win, const struct KeyEvent *event)
	Perform a Pager function - Implements function_dispatcher_t -.
struct MenuDefinition *	pager_get_menu_definition (void)
	Get the Pager Menu Definition.

Variables
static const char *	Not_available_in_this_menu = N_("Not available in this menu")
	Error message for unavailable functions.
static const struct MenuFuncOp	OpPager []
	Functions for the Pager Menu.
static const struct MenuOpSeq	PagerDefaultBindings []
	Key bindings for the Pager Menu.
static const struct PagerFunction	PagerFunctions []
	All the NeoMutt functions that the Pager supports.

Detailed Description

Pager functions.

Authors

• Richard Russon

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 functions.c.

Function Documentation

pager_init_keys()

void pager_init_keys	(	struct NeoMutt *	n,
		struct SubMenu *	sm_generic )

Initialise the Pager Keybindings - Implements ::init_keys_api.

Definition at line 108 of file functions.c.

{
  struct MenuDefinition *md = NULL;
  struct SubMenu *sm_pager = NULL;
  struct SubMenu *sm_index = index_get_submenu();
  struct SubMenu *sm_sidebar = sidebar_get_submenu();
 
  sm_pager = km_register_submenu(OpPager);
  md = km_register_menu(MENU_PAGER, "pager");
  km_menu_add_submenu(md, sm_pager);
  km_menu_add_submenu(md, sm_index);
  km_menu_add_submenu(md, sm_sidebar);
  km_menu_add_submenu(md, sm_generic);
  km_menu_add_bindings(md, PagerDefaultBindings);
 
  struct PagerModuleData *mod_data = neomutt_get_module_data(n, MODULE_ID_PAGER);
  ASSERT(mod_data);
  mod_data->md_pager = md;
}

Here is the call graph for this function:

Here is the caller graph for this function:

assert_pager_mode()

bool assert_pager_mode ( bool test )

inlinestatic

Check that pager is in correct mode.

Parameters

test	Test condition

Return values

true	Expected mode is set
false	Pager is is some other mode

Note

On failure, the input will be flushed and an error message displayed

Definition at line 136 of file functions.c.

{
  if (test)
    return true;
 
  mutt_flushinp();
  mutt_error("%s", _(Not_available_in_this_menu));
  return false;
}

Here is the call graph for this function:

Here is the caller graph for this function:

up_n_lines()

int up_n_lines ( int nlines, struct Line * info, int cur, bool hiding )

static

Reposition the pager's view up by n lines.

Parameters

nlines	Number of lines to move
info	Line info array
cur	Current line number
hiding	true if lines have been hidden

Return values

num	New current line number

Definition at line 154 of file functions.c.

{
  while ((cur > 0) && (nlines > 0))
  {
    cur--;
    if (!hiding || !COLOR_QUOTED(info[cur].cid))
      nlines--;
  }
 
  return cur;
}

Here is the caller graph for this function:

down_n_lines()

int down_n_lines ( int nlines, struct Line * info, int cur, int max, bool hiding )

static

Reposition the pager's view down by n lines.

Parameters

nlines	Number of lines to move
info	Line info array
cur	Current line number
max	Number of lines used
hiding	true if lines have been hidden

Return values

num	New current line number

Definition at line 175 of file functions.c.

{
  while ((cur < max) && (nlines > 0))
  {
    cur++;
    if ((cur < max) && (!hiding || !COLOR_QUOTED(info[cur].cid)))
      nlines--;
  }
 
  if (cur > max)
    cur = max;
 
  return cur;
}

Here is the caller graph for this function:

jump_to_bottom()

bool jump_to_bottom	(	struct PagerPrivateData *	priv,
		struct PagerView *	pview )

Make sure the bottom line is displayed.

Parameters

priv	Private Pager data
pview	PagerView

Return values

true	Something changed
false	Bottom was already displayed

Definition at line 197 of file functions.c.

{
  if (!(priv->lines[priv->cur_line].offset < (priv->st.st_size - 1)))
  {
    return false;
  }
 
  int line_num = priv->cur_line;
  /* make sure the types are defined to the end of file */
  while (display_line(priv->fp, &priv->bytes_read, &priv->lines, line_num,
                      &priv->lines_used, &priv->lines_max,
                      priv->has_types | (pview->flags & MUTT_PAGER_NOWRAP),
                      &priv->quote_list, &priv->q_level, &priv->force_redraw,
                      &priv->search_re, priv->pview->win_pager, &priv->ansi_list) == 0)
  {
    line_num++;
  }
  priv->top_line = up_n_lines(priv->pview->win_pager->state.rows, priv->lines,
                              priv->lines_used, priv->hide_quoted);
  notify_send(priv->notify, NT_PAGER, NT_PAGER_VIEW, priv);
  return true;
}

Here is the call graph for this function:

Here is the caller graph for this function:

pager_skip_quoted_once()

int pager_skip_quoted_once ( struct PagerPrivateData * priv, struct PagerFunctionData * fdata )

static

Skip to next unquoted block.

Parameters

priv	Pager private data
fdata	Pager function data

Return values

0	Success
-1	No more unquoted text

Definition at line 750 of file functions.c.

{
  struct PagerView *pview = priv->pview;
  const short c_pager_skip_quoted_context = cs_subset_number(fdata->n->sub, "pager_skip_quoted_context");
  int rc = 0;
  int new_topline = priv->top_line;
  int num_quoted = 0;
 
  /* In a header? Skip all the email headers, and done */
  if (color_is_header(priv->lines[new_topline].cid))
  {
    while (((new_topline < priv->lines_used) ||
            (0 == (rc = display_line(priv->fp, &priv->bytes_read, &priv->lines,
                                     new_topline, &priv->lines_used, &priv->lines_max,
                                     MUTT_TYPES | (pview->flags & MUTT_PAGER_NOWRAP), &priv->quote_list,
                                     &priv->q_level, &priv->force_redraw, &priv->search_re,
                                     priv->pview->win_pager, &priv->ansi_list)))) &&
           color_is_header(priv->lines[new_topline].cid))
    {
      new_topline++;
    }
    priv->top_line = new_topline;
    notify_send(priv->notify, NT_PAGER, NT_PAGER_VIEW, priv);
    return 0;
  }
 
  /* Already in the body? Skip past previous "context" quoted lines */
  if (c_pager_skip_quoted_context > 0)
  {
    while (((new_topline < priv->lines_used) ||
            (0 == (rc = display_line(priv->fp, &priv->bytes_read, &priv->lines,
                                     new_topline, &priv->lines_used, &priv->lines_max,
                                     MUTT_TYPES | (pview->flags & MUTT_PAGER_NOWRAP), &priv->quote_list,
                                     &priv->q_level, &priv->force_redraw, &priv->search_re,
                                     priv->pview->win_pager, &priv->ansi_list)))) &&
           COLOR_QUOTED(priv->lines[new_topline].cid))
    {
      new_topline++;
      num_quoted++;
    }
 
    if (rc < 0)
      return -1;
  }
 
  if (num_quoted <= c_pager_skip_quoted_context)
  {
    num_quoted = 0;
 
    while (((new_topline < priv->lines_used) ||
            (0 == (rc = display_line(priv->fp, &priv->bytes_read, &priv->lines,
                                     new_topline, &priv->lines_used, &priv->lines_max,
                                     MUTT_TYPES | (pview->flags & MUTT_PAGER_NOWRAP), &priv->quote_list,
                                     &priv->q_level, &priv->force_redraw, &priv->search_re,
                                     priv->pview->win_pager, &priv->ansi_list)))) &&
           !COLOR_QUOTED(priv->lines[new_topline].cid))
    {
      new_topline++;
    }
 
    if (rc < 0)
      return -1;
 
    while (((new_topline < priv->lines_used) ||
            (0 == (rc = display_line(priv->fp, &priv->bytes_read, &priv->lines,
                                     new_topline, &priv->lines_used, &priv->lines_max,
                                     MUTT_TYPES | (pview->flags & MUTT_PAGER_NOWRAP), &priv->quote_list,
                                     &priv->q_level, &priv->force_redraw, &priv->search_re,
                                     priv->pview->win_pager, &priv->ansi_list)))) &&
           COLOR_QUOTED(priv->lines[new_topline].cid))
    {
      new_topline++;
      num_quoted++;
    }
 
    if (rc < 0)
      return -1;
  }
  priv->top_line = new_topline - MIN(c_pager_skip_quoted_context, num_quoted);
  notify_send(priv->notify, NT_PAGER, NT_PAGER_VIEW, priv);
  return 0;
}

Here is the call graph for this function:

Here is the caller graph for this function:

pager_get_menu_definition()

struct MenuDefinition * pager_get_menu_definition

(

void

)

Get the Pager Menu Definition.

Return values

ptr	Pager Menu Definition

Definition at line 1116 of file functions.c.

{
  struct PagerModuleData *mod_data = neomutt_get_module_data(NeoMutt, MODULE_ID_PAGER);
  ASSERT(mod_data);
 
  return mod_data->md_pager;
}

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

Not_available_in_this_menu

const char* Not_available_in_this_menu = N_("Not available in this menu")

static

Error message for unavailable functions.

Definition at line 58 of file functions.c.

OpPager

const struct MenuFuncOp OpPager[]

static

Initial value:

                              = { 
  { "search-toggle",                 OP_SEARCH_TOGGLE },
  { "skip-headers",                  OP_PAGER_SKIP_HEADERS },
  { "skip-quoted",                   OP_PAGER_SKIP_QUOTED },
  { "toggle-quoted",                 OP_PAGER_HIDE_QUOTED },
 
  
  { "bottom",                        OP_LAST_ENTRY,        MFF_DEPRECATED },
  { "buffy-list",                    OP_MAILBOX_LIST,      MFF_DEPRECATED },
  { "error-history",                 OP_SHOW_LOG_MESSAGES, MFF_DEPRECATED },
  { "mark-as-new",                   OP_TOGGLE_NEW,        MFF_DEPRECATED },
  { "tag-message",                   OP_TAG,               MFF_DEPRECATED },
  { "top",                           OP_FIRST_ENTRY,       MFF_DEPRECATED },
  { NULL, 0 },
}

Functions for the Pager Menu.

Definition at line 66 of file functions.c.

                                         { /* map: pager */
  { "search-toggle",                 OP_SEARCH_TOGGLE },
  { "skip-headers",                  OP_PAGER_SKIP_HEADERS },
  { "skip-quoted",                   OP_PAGER_SKIP_QUOTED },
  { "toggle-quoted",                 OP_PAGER_HIDE_QUOTED },
 
  // Deprecated
  { "bottom",                        OP_LAST_ENTRY,        MFF_DEPRECATED },
  { "buffy-list",                    OP_MAILBOX_LIST,      MFF_DEPRECATED },
  { "error-history",                 OP_SHOW_LOG_MESSAGES, MFF_DEPRECATED },
  { "mark-as-new",                   OP_TOGGLE_NEW,        MFF_DEPRECATED },
  { "tag-message",                   OP_TAG,               MFF_DEPRECATED },
  { "top",                           OP_FIRST_ENTRY,       MFF_DEPRECATED },
  { NULL, 0 },
};

PagerDefaultBindings

const struct MenuOpSeq PagerDefaultBindings[]

static

Initial value:

                             = { 
  { OP_EXIT,                               "q" },
  { OP_MAIN_NEXT_UNDELETED,                "<right>" },
  { OP_MAIN_PREV_UNDELETED,                "<left>" },
  { OP_NEXT_LINE,                          "<keypadenter>" },
  { OP_NEXT_LINE,                          "\n" },             
  { OP_NEXT_LINE,                          "\r" },             
  { OP_NEXT_PAGE,                          " " },              
  { OP_PAGER_HIDE_QUOTED,                  "T" },
  { OP_PAGER_SKIP_HEADERS,                 "H" },
  { OP_PAGER_SKIP_QUOTED,                  "S" },
  { OP_FIRST_ENTRY,                        "^" },
  { OP_PREV_LINE,                          "<backspace>" },
  { OP_PREV_PAGE,                          "-" },
  { OP_QUIT,                               "Q" },
  { OP_SEARCH_TOGGLE,                      "\\" },             
  { 0, NULL },
}

Key bindings for the Pager Menu.

Definition at line 85 of file functions.c.

                                                     { /* map: pager */
  { OP_EXIT,                               "q" },
  { OP_MAIN_NEXT_UNDELETED,                "<right>" },
  { OP_MAIN_PREV_UNDELETED,                "<left>" },
  { OP_NEXT_LINE,                          "<keypadenter>" },
  { OP_NEXT_LINE,                          "\n" },             // <Enter>
  { OP_NEXT_LINE,                          "\r" },             // <Return>
  { OP_NEXT_PAGE,                          " " },              // <Space>
  { OP_PAGER_HIDE_QUOTED,                  "T" },
  { OP_PAGER_SKIP_HEADERS,                 "H" },
  { OP_PAGER_SKIP_QUOTED,                  "S" },
  { OP_FIRST_ENTRY,                        "^" },
  { OP_PREV_LINE,                          "<backspace>" },
  { OP_PREV_PAGE,                          "-" },
  { OP_QUIT,                               "Q" },
  { OP_SEARCH_TOGGLE,                      "\\" },             // <Backslash>
  { 0, NULL },
};

PagerFunctions

const struct PagerFunction PagerFunctions[]

static

All the NeoMutt functions that the Pager supports.

Definition at line 1017 of file functions.c.

                                                   {
  // clang-format off
  { OP_EXIT,                   op_exit },
  { OP_FIRST_ENTRY,            op_first_entry },
  { OP_HALF_DOWN,              op_pager_half_down },
  { OP_HALF_UP,                op_pager_half_up },
  { OP_HELP,                   op_help },
  { OP_LAST_ENTRY,             op_last_entry },
  { OP_NEXT_LINE,              op_pager_next_line },
  { OP_NEXT_PAGE,              op_pager_next_page },
  { OP_PAGER_HIDE_QUOTED,      op_pager_hide_quoted },
  { OP_PAGER_SKIP_HEADERS,     op_pager_skip_headers },
  { OP_PAGER_SKIP_QUOTED,      op_pager_skip_quoted },
  { OP_PREV_LINE,              op_pager_prev_line },
  { OP_PREV_PAGE,              op_pager_prev_page },
  { OP_QUIT,                   op_quit },
  { OP_SAVE,                   op_save },
  { OP_SEARCH,                 op_pager_search },
  { OP_SEARCH_NEXT,            op_pager_search_next },
  { OP_SEARCH_OPPOSITE,        op_pager_search_next },
  { OP_SEARCH_REVERSE,         op_pager_search },
  { OP_SEARCH_TOGGLE,          op_search_toggle },
  { OP_VIEW_ATTACHMENTS,       op_view_attachments },
 
  // OpGeneric - Ignore
  { OP_CURRENT_MIDDLE,         op_ignore },
  { OP_CURRENT_TOP,            op_ignore },
  { OP_CURRENT_BOTTOM,         op_ignore },
  { OP_BOTTOM_PAGE,            op_ignore },
  { OP_MIDDLE_PAGE,            op_ignore },
  { OP_GENERIC_SELECT_ENTRY,   op_ignore },
  { OP_TOP_PAGE,               op_ignore },
  { 0, NULL },
  // clang-format on
};