dlg_pager.c File Reference

Pager Dialog. More...

#include "config.h"
#include <inttypes.h>
#include <stdbool.h>
#include <string.h>
#include <sys/stat.h>
#include <unistd.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 "debug/lib.h"
#include "lib.h"
#include "color/lib.h"
#include "expando/lib.h"
#include "index/lib.h"
#include "key/lib.h"
#include "pattern/lib.h"
#include "sidebar/lib.h"
#include "display.h"
#include "functions.h"
#include "module_data.h"
#include "mutt_logging.h"
#include "mutt_mailbox.h"
#include "mx.h"
#include "private_data.h"

Include dependency graph for dlg_pager.c:

Go to the source code of this file.

Functions
void	pager_queue_redraw (struct PagerPrivateData *priv, PagerRedrawFlags redraw)
	Queue a request for a redraw.
static const struct Mapping *	pager_resolve_help_mapping (enum PagerMode mode, enum MailboxType type)
	Determine help mapping based on pager mode and mailbox type.
static bool	check_read_delay (uint64_t *timestamp)
	Is it time to mark the message read?
int	dlg_pager (struct PagerView *pview)
	Display an email, attachment, or help, in a window -.

Variables
static const struct Mapping	PagerHelp []
	Help Bar for the Pager's Help Page.
static const struct Mapping	PagerHelpHelp []
	Help Bar for the Help Page itself.
static const struct Mapping	PagerNormalHelp []
	Help Bar for the Pager of a normal Mailbox.
static const struct Mapping	PagerNewsHelp []
	Help Bar for the Pager of an NNTP Mailbox.

Detailed Description

Pager Dialog.

Authors

• Richard Russon
• R Primus
• Pietro Cerutti
• Eric Blake
• 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 dlg_pager.c.

Function Documentation

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

pager_resolve_help_mapping()

static const struct Mapping * pager_resolve_help_mapping ( enum PagerMode mode, enum MailboxType type )

static

Determine help mapping based on pager mode and mailbox type.

Parameters

mode	pager mode
type	mailbox type

Return values

ptr	Help Mapping

Definition at line 135 of file dlg_pager.c.

{
  const struct Mapping *result = NULL;
  switch (mode)
  {
    case PAGER_MODE_EMAIL:
    case PAGER_MODE_ATTACH:
    case PAGER_MODE_ATTACH_E:
      if (type == MUTT_NNTP)
        result = PagerNewsHelp;
      else
        result = PagerNormalHelp;
      break;
 
    case PAGER_MODE_HELP:
      result = PagerHelpHelp;
      break;
 
    case PAGER_MODE_OTHER:
      result = PagerHelp;
      break;
 
    case PAGER_MODE_UNKNOWN:
    case PAGER_MODE_MAX:
    default:
      ASSERT(false); // something went really wrong
  }
  ASSERT(result);
  return result;
}

Here is the caller graph for this function:

check_read_delay()

static bool check_read_delay ( uint64_t * timestamp )

static

Is it time to mark the message read?

Parameters

timestamp

Time when message should be marked read, or 0

Return values

true	Message should be marked read
false	No action necessary

Definition at line 172 of file dlg_pager.c.

{
  if ((*timestamp != 0) && (mutt_date_now_ms() > *timestamp))
  {
    *timestamp = 0;
    return true;
  }
  return false;
}

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

PagerHelp

const struct Mapping PagerHelp[]

static

Initial value:

= {
  
  { N_("Exit"),          OP_EXIT },
  { N_("PrevPg"),        OP_PREV_PAGE },
  { N_("NextPg"),        OP_NEXT_PAGE },
  { N_("Help"),          OP_HELP },
  { NULL, 0 },
  
}

Help Bar for the Pager's Help Page.

Definition at line 66 of file dlg_pager.c.

                                          {
  // clang-format off
  { N_("Exit"),          OP_EXIT },
  { N_("PrevPg"),        OP_PREV_PAGE },
  { N_("NextPg"),        OP_NEXT_PAGE },
  { N_("Help"),          OP_HELP },
  { NULL, 0 },
  // clang-format on
};

PagerHelpHelp

const struct Mapping PagerHelpHelp[]

static

Initial value:

= {
  
  { N_("Exit"),          OP_EXIT },
  { N_("PrevPg"),        OP_PREV_PAGE },
  { N_("NextPg"),        OP_NEXT_PAGE },
  { NULL, 0 },
  
}

Help Bar for the Help Page itself.

Definition at line 77 of file dlg_pager.c.

                                              {
  // clang-format off
  { N_("Exit"),          OP_EXIT },
  { N_("PrevPg"),        OP_PREV_PAGE },
  { N_("NextPg"),        OP_NEXT_PAGE },
  { NULL, 0 },
  // clang-format on
};

PagerNormalHelp

const struct Mapping PagerNormalHelp[]

static

Initial value:

= {
  
  { N_("Exit"),          OP_EXIT },
  { N_("PrevPg"),        OP_PREV_PAGE },
  { N_("NextPg"),        OP_NEXT_PAGE },
  { N_("View Attachm."), OP_VIEW_ATTACHMENTS },
  { N_("Del"),           OP_DELETE },
  { N_("Reply"),         OP_REPLY },
  { N_("Next"),          OP_MAIN_NEXT_UNDELETED },
  { N_("Help"),          OP_HELP },
  { NULL, 0 },
  
}

Help Bar for the Pager of a normal Mailbox.

Definition at line 87 of file dlg_pager.c.

                                                {
  // clang-format off
  { N_("Exit"),          OP_EXIT },
  { N_("PrevPg"),        OP_PREV_PAGE },
  { N_("NextPg"),        OP_NEXT_PAGE },
  { N_("View Attachm."), OP_VIEW_ATTACHMENTS },
  { N_("Del"),           OP_DELETE },
  { N_("Reply"),         OP_REPLY },
  { N_("Next"),          OP_MAIN_NEXT_UNDELETED },
  { N_("Help"),          OP_HELP },
  { NULL, 0 },
  // clang-format on
};

PagerNewsHelp

const struct Mapping PagerNewsHelp[]

static

Initial value:

= {
  
  { N_("Exit"),          OP_EXIT },
  { N_("PrevPg"),        OP_PREV_PAGE },
  { N_("NextPg"),        OP_NEXT_PAGE },
  { N_("Post"),          OP_POST },
  { N_("Followup"),      OP_FOLLOWUP },
  { N_("Del"),           OP_DELETE },
  { N_("Next"),          OP_MAIN_NEXT_UNDELETED },
  { N_("Help"),          OP_HELP },
  { NULL, 0 },
  
}

Help Bar for the Pager of an NNTP Mailbox.

Definition at line 102 of file dlg_pager.c.

                                              {
  // clang-format off
  { N_("Exit"),          OP_EXIT },
  { N_("PrevPg"),        OP_PREV_PAGE },
  { N_("NextPg"),        OP_NEXT_PAGE },
  { N_("Post"),          OP_POST },
  { N_("Followup"),      OP_FOLLOWUP },
  { N_("Del"),           OP_DELETE },
  { N_("Next"),          OP_MAIN_NEXT_UNDELETED },
  { N_("Help"),          OP_HELP },
  { NULL, 0 },
  // clang-format on
};