functions.c File Reference

Pager functions. More...

#include "config.h"
#include <inttypes.h>
#include <stdbool.h>
#include <stddef.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 "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 "display.h"
#include "functions.h"
#include "muttlib.h"
#include "private_data.h"
#include "protos.h"

Include dependency graph for functions.c:

Go to the source code of this file.

Functions
static int	op_pager_search_next (struct IndexSharedData *shared, struct PagerPrivateData *priv, int op)
	Search for next match - Implements pager_function_t -.
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.
bool	jump_to_bottom (struct PagerPrivateData *priv, struct PagerView *pview)
	Make sure the bottom line is displayed.
static int	op_pager_bottom (struct IndexSharedData *shared, struct PagerPrivateData *priv, int op)
	Jump to the bottom of the message - Implements pager_function_t -.
static int	op_pager_half_down (struct IndexSharedData *shared, struct PagerPrivateData *priv, int op)
	Scroll down 1/2 page - Implements pager_function_t -.
static int	op_pager_half_up (struct IndexSharedData *shared, struct PagerPrivateData *priv, int op)
	Scroll up 1/2 page - Implements pager_function_t -.
static int	op_pager_hide_quoted (struct IndexSharedData *shared, struct PagerPrivateData *priv, int op)
	Toggle display of quoted text - Implements pager_function_t -.
static int	op_pager_next_line (struct IndexSharedData *shared, struct PagerPrivateData *priv, int op)
	Scroll down one line - Implements pager_function_t -.
static int	op_pager_next_page (struct IndexSharedData *shared, struct PagerPrivateData *priv, int op)
	Move to the next page - Implements pager_function_t -.
static int	op_pager_prev_line (struct IndexSharedData *shared, struct PagerPrivateData *priv, int op)
	Scroll up one line - Implements pager_function_t -.
static int	op_pager_prev_page (struct IndexSharedData *shared, struct PagerPrivateData *priv, int op)
	Move to the previous page - Implements pager_function_t -.
static int	op_pager_search (struct IndexSharedData *shared, struct PagerPrivateData *priv, int op)
	Search for a regular expression - Implements pager_function_t -.
static int	op_pager_skip_headers (struct IndexSharedData *shared, struct PagerPrivateData *priv, int op)
	Jump to first line after headers - Implements pager_function_t -.
static int	op_pager_skip_quoted (struct IndexSharedData *shared, struct PagerPrivateData *priv, int op)
	Skip beyond quoted text - Implements pager_function_t -.
static int	op_pager_top (struct IndexSharedData *shared, struct PagerPrivateData *priv, int op)
	Jump to the top of the message - Implements pager_function_t -.
static int	op_exit (struct IndexSharedData *shared, struct PagerPrivateData *priv, int op)
	Exit this menu - Implements pager_function_t -.
static int	op_help (struct IndexSharedData *shared, struct PagerPrivateData *priv, int op)
	This screen - Implements pager_function_t -.
static int	op_save (struct IndexSharedData *shared, struct PagerPrivateData *priv, int op)
	Save the Pager text - Implements pager_function_t -.
static int	op_search_toggle (struct IndexSharedData *shared, struct PagerPrivateData *priv, int op)
	Toggle search pattern coloring - Implements pager_function_t -.
static int	op_view_attachments (struct IndexSharedData *shared, struct PagerPrivateData *priv, int op)
	Show MIME attachments - Implements pager_function_t -.
int	pager_function_dispatcher (struct MuttWindow *win, int op)
	Perform a Pager function - Implements function_dispatcher_t -.

Variables
static const char *	Not_available_in_this_menu = N_("Not available in this menu")
	Error message for unavailable functions.
const struct MenuFuncOp	OpPager []
	Functions for the Pager Menu.
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

assert_pager_mode()

static 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 339 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()

static 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 357 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:

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 376 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:

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 62 of file functions.c.

OpPager

const struct MenuFuncOp OpPager[]

Functions for the Pager Menu.

Definition at line 71 of file functions.c.

PagerDefaultBindings

const struct MenuOpSeq PagerDefaultBindings[]

Key bindings for the Pager Menu.

Definition at line 229 of file functions.c.

PagerFunctions

const struct PagerFunction PagerFunctions[]

static

Initial value:

= {
  
  { OP_EXIT,                   op_exit },
  { OP_HALF_DOWN,              op_pager_half_down },
  { OP_HALF_UP,                op_pager_half_up },
  { OP_HELP,                   op_help },
  { OP_NEXT_LINE,              op_pager_next_line },
  { OP_NEXT_PAGE,              op_pager_next_page },
  { OP_PAGER_BOTTOM,           op_pager_bottom },
  { 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_PAGER_TOP,              op_pager_top },
  { OP_PREV_LINE,              op_pager_prev_line },
  { OP_PREV_PAGE,              op_pager_prev_page },
  { OP_SAVE,                   op_save },
  { OP_SEARCH,                 op_pager_search },
  { OP_SEARCH_REVERSE,         op_pager_search },
  { OP_SEARCH_NEXT,            op_pager_search_next },
  { OP_SEARCH_OPPOSITE,        op_pager_search_next },
  { OP_SEARCH_TOGGLE,          op_search_toggle },
  { OP_VIEW_ATTACHMENTS,       op_view_attachments },
  { 0, NULL },
  
}

All the NeoMutt functions that the Pager supports.

Definition at line 1097 of file functions.c.