functions.c File Reference

Postponed Emails Functions. More...

#include "config.h"
#include <stdbool.h>
#include <stddef.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 "key/lib.h"
#include "menu/lib.h"
#include "pattern/lib.h"
#include "module_data.h"

Include dependency graph for functions.c:

Go to the source code of this file.

Functions
void	postponed_init_keys (struct NeoMutt *n, struct SubMenu *sm_generic)
	Initialise the Postponed Keybindings - Implements ::init_keys_api.
static int	postpone_add_selection (struct EmailArray *ea, struct Menu *menu, struct Mailbox *m, bool tagged, int count)
	Build a working set of Emails for an action.
static void	postpone_apply_set_deleted (struct Mailbox *m, struct EmailArray *ea, bool deleted)
	Apply the deleted flag to a working set of Emails.
static int	op_delete (struct PostponeData *pd, const struct KeyEvent *event)
	Delete the current entry - Implements postpone_function_t -.
static int	op_exit (struct PostponeData *pd, const struct KeyEvent *event)
	Exit this menu - Implements postpone_function_t -.
static int	op_generic_select_entry (struct PostponeData *pd, const struct KeyEvent *event)
	Select the current entry - Implements postpone_function_t -.
static int	op_search (struct PostponeData *pd, const struct KeyEvent *event)
	Search for a regular expression - Implements postpone_function_t -.
int	postpone_function_dispatcher (struct MuttWindow *win, const struct KeyEvent *event)
	Perform a Postpone function - Implements function_dispatcher_t -.
struct MailboxView *	postponed_get_mailbox_view (struct MuttWindow *dlg)
	Extract the Mailbox from the Postponed Dialog.

Variables
static const struct MenuFuncOp	OpPostponed []
	Functions for the Postpone Menu.
static const struct MenuOpSeq	PostponedDefaultBindings []
	Key bindings for the Postpone Menu.
static const struct PostponeFunction	PostponeFunctions []
	All the NeoMutt functions that the Postpone supports.

Detailed Description

Postponed Emails Functions.

Authors

• Richard Russon
• Dennis Schön

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

postponed_init_keys()

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

Initialise the Postponed Keybindings - Implements ::init_keys_api.

Definition at line 72 of file functions.c.

{
  struct MenuDefinition *md = NULL;
  struct SubMenu *sm = NULL;
 
  sm = km_register_submenu(OpPostponed);
  md = km_register_menu(MENU_POSTPONE, "postpone");
  km_menu_add_submenu(md, sm);
  km_menu_add_submenu(md, sm_generic);
  km_menu_add_bindings(md, PostponedDefaultBindings);
 
  struct PostponeModuleData *mod_data = neomutt_get_module_data(n, MODULE_ID_POSTPONE);
  ASSERT(mod_data);
  mod_data->menu_postpone = md;
}

Here is the call graph for this function:

Here is the caller graph for this function:

postpone_add_selection()

static int postpone_add_selection ( struct EmailArray * ea, struct Menu * menu, struct Mailbox * m, bool tagged, int count )

static

Build a working set of Emails for an action.

Parameters

ea	Empty EmailArray to populate
menu	Postpone Menu
m	Mailbox
tagged	Use tagged emails (tag-prefix)
count	Repeat-count (0 or 1 == just the current selection)

Return values

num	Number of emails added

If tagged is true, the array is filled with the tagged emails and count is ignored.

Otherwise the array is filled with the current selection and the next count - 1 emails. Overruns are silently capped at the end of the list.

Definition at line 103 of file functions.c.

{
  if (!ea || !menu || !m || !m->emails)
    return 0;
 
  if (tagged)
  {
    for (int i = 0; i < m->msg_count; i++)
    {
      struct Email *e = m->emails[i];
      if (e && e->tagged)
        ARRAY_ADD(ea, e);
    }
  }
  else
  {
    const int index = menu_get_index(menu);
    if ((index < 0) || (index >= m->msg_count))
      return 0;
 
    int n = (count > 1) ? count : 1;
    if ((index + n) > m->msg_count)
      n = m->msg_count - index;
 
    for (int i = 0; i < n; i++)
    {
      struct Email *e = m->emails[index + i];
      if (e)
        ARRAY_ADD(ea, e);
    }
  }
 
  return ARRAY_SIZE(ea);
}

Here is the call graph for this function:

Here is the caller graph for this function:

postpone_apply_set_deleted()

static void postpone_apply_set_deleted ( struct Mailbox * m, struct EmailArray * ea, bool deleted )

static

Apply the deleted flag to a working set of Emails.

Parameters

m	Mailbox
ea	Working set of Emails
deleted	true to mark as deleted, false to undelete

Also updates the postponed message count.

Definition at line 147 of file functions.c.

{
  if (!m || !ea)
    return;
 
  struct Email **ep = NULL;
  ARRAY_FOREACH(ep, ea)
  {
    if (*ep)
      mutt_set_flag(m, *ep, MUTT_DELETE, deleted, true);
  }
 
  struct PostponeModuleData *mod_data = neomutt_get_module_data(NeoMutt, MODULE_ID_POSTPONE);
  if (mod_data)
    mod_data->post_count = m->msg_count - m->msg_deleted;
}

Here is the call graph for this function:

Here is the caller graph for this function:

postponed_get_mailbox_view()

struct MailboxView * postponed_get_mailbox_view

(

struct MuttWindow *

dlg

)

Extract the Mailbox from the Postponed Dialog.

Parameters

dlg	Postponed Dialog

Return values

ptr	Mailbox view

Definition at line 337 of file functions.c.

{
  if (!dlg)
    return NULL;
 
  struct Menu *menu = dlg->wdata;
  struct PostponeData *pd = menu->mdata;
  if (!pd)
    return NULL;
 
  return pd->mailbox_view;
}

Here is the caller graph for this function:

Variable Documentation

OpPostponed

const struct MenuFuncOp OpPostponed[]

static

Initial value:

= { 
  { "exit",                          OP_EXIT },
  { "delete-entry",                  OP_DELETE },
  { "undelete-entry",                OP_UNDELETE },
  { "tag-entry",                     OP_TAG },
  { NULL, 0 },
}

Functions for the Postpone Menu.

Definition at line 49 of file functions.c.

                                               { /* map: postpone */
  { "exit",                          OP_EXIT },
  { "delete-entry",                  OP_DELETE },
  { "undelete-entry",                OP_UNDELETE },
  { "tag-entry",                     OP_TAG },
  { NULL, 0 },
};

PostponedDefaultBindings

const struct MenuOpSeq PostponedDefaultBindings[]

static

Initial value:

= { 
  { OP_DELETE,                             "d" },
  { OP_EXIT,                               "q" },
  { OP_TAG,                                "t" },
  { OP_UNDELETE,                           "u" },
  { 0, NULL },
}

Key bindings for the Postpone Menu.

Definition at line 60 of file functions.c.

                                                           { /* map: postpone */
  { OP_DELETE,                             "d" },
  { OP_EXIT,                               "q" },
  { OP_TAG,                                "t" },
  { OP_UNDELETE,                           "u" },
  { 0, NULL },
};

PostponeFunctions

const struct PostponeFunction PostponeFunctions[]

static

Initial value:

= {
  
  { OP_DELETE,                 op_delete },
  { OP_EXIT,                   op_exit },
  { OP_GENERIC_SELECT_ENTRY,   op_generic_select_entry },
  { OP_SEARCH,                 op_search },
  { OP_SEARCH_NEXT,            op_search },
  { OP_SEARCH_OPPOSITE,        op_search },
  { OP_SEARCH_REVERSE,         op_search },
  { OP_UNDELETE,               op_delete },
  { 0, NULL },
  
}

All the NeoMutt functions that the Postpone supports.

Definition at line 275 of file functions.c.

                                                           {
  // clang-format off
  { OP_DELETE,                 op_delete },
  { OP_EXIT,                   op_exit },
  { OP_GENERIC_SELECT_ENTRY,   op_generic_select_entry },
  { OP_SEARCH,                 op_search },
  { OP_SEARCH_NEXT,            op_search },
  { OP_SEARCH_OPPOSITE,        op_search },
  { OP_SEARCH_REVERSE,         op_search },
  { OP_UNDELETE,               op_delete },
  { 0, NULL },
  // clang-format on
};