selection.c File Reference

Build a selection of Emails for an action. More...

#include "config.h"
#include <stdbool.h>
#include <stddef.h>
#include "mutt/lib.h"
#include "email/lib.h"
#include "core/lib.h"
#include "mview.h"

Include dependency graph for selection.c:

Go to the source code of this file.

Functions
static bool	ea_contains_email (struct EmailArray *ea, struct Email *e)
	Does a working set already include an Email?
static void	ea_add_email (struct EmailArray *ea, struct Email *e)
	Add an Email to a working set.
static void	ea_add_collapsed_thread (struct EmailArray *ea, struct Email *e)
	Add all emails in a collapsed thread.
static void	ea_add_folded (struct EmailArray *ea, struct Email *e)
	Add an Email, expanding collapsed threads.
int	ea_add_tagged (struct EmailArray *ea, struct MailboxView *mv, struct Email *e, bool use_tagged)
	Get an array of the tagged Emails.

Detailed Description

Build a selection of Emails for an action.

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

Function Documentation

ea_contains_email()

static bool ea_contains_email ( struct EmailArray * ea, struct Email * e )

static

Does a working set already include an Email?

Parameters

ea	Selected emails
e	Candidate email

Return values

true	Email is selected

Definition at line 43 of file selection.c.

{
  if (!ea || !e)
    return false;
 
  struct Email **ep = NULL;
  ARRAY_FOREACH(ep, ea)
  {
    if (*ep == e)
      return true;
  }
 
  return false;
}

Here is the caller graph for this function:

ea_add_email()

static void ea_add_email ( struct EmailArray * ea, struct Email * e )

static

Add an Email to a working set.

Parameters

ea	Selected emails
e	Email to add

Definition at line 63 of file selection.c.

{
  if (!ea_contains_email(ea, e))
    ARRAY_ADD(ea, e);
}

Here is the call graph for this function:

Here is the caller graph for this function:

ea_add_collapsed_thread()

static void ea_add_collapsed_thread ( struct EmailArray * ea, struct Email * e )

static

Add all emails in a collapsed thread.

Parameters

ea	Selected emails
e	Collapsed email

Definition at line 74 of file selection.c.

{
  if (!e || !e->collapsed || !e->thread)
    return;
 
  struct MuttThread *top = e->thread;
  while (top->parent)
    top = top->parent;
 
  struct MuttThread *thread = top;
  while (thread)
  {
    struct Email *et = thread->message;
    if (et && et->visible)
      ea_add_email(ea, et);
 
    if (thread->child)
    {
      thread = thread->child;
      continue;
    }
 
    // Leaf node: backtrack to find the next sibling,
    // but stay within the subtree rooted at `top`
    while ((thread != top) && !thread->next)
      thread = thread->parent;
 
    if (thread == top)
      break;
 
    thread = thread->next;
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

ea_add_folded()

static void ea_add_folded ( struct EmailArray * ea, struct Email * e )

static

Add an Email, expanding collapsed threads.

Parameters

ea	Selected emails
e	Email to add

Definition at line 113 of file selection.c.

{
  ea_add_email(ea, e);
  ea_add_collapsed_thread(ea, e);
}

Here is the call graph for this function:

Here is the caller graph for this function:

ea_add_tagged()

int ea_add_tagged	(	struct EmailArray *	ea,
		struct MailboxView *	mv,
		struct Email *	e,
		bool	use_tagged )

Get an array of the tagged Emails.

Parameters

ea	Empty EmailArray to populate
mv	Current Mailbox
e	Current Email
use_tagged	Use tagged Emails

Return values

num	Number of selected emails
-1	Error

Definition at line 128 of file selection.c.

{
  if (use_tagged)
  {
    if (!mv || !mv->mailbox || !mv->mailbox->emails)
      return -1;
 
    struct Mailbox *m = mv->mailbox;
    for (int i = 0; i < m->msg_count; i++)
    {
      e = m->emails[i];
      if (!e)
        break;
      if (!message_is_tagged(e))
        continue;
 
      ea_add_folded(ea, e);
    }
  }
  else
  {
    if (!e)
      return -1;
 
    ea_add_folded(ea, e);
  }
 
  return ARRAY_SIZE(ea);
}

Here is the call graph for this function:

Here is the caller graph for this function: