selection.c File Reference

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

#include "config.h"
#include <stdbool.h>
#include <stddef.h>
#include "mutt/lib.h"
#include "email/lib.h"
#include "menu/lib.h"
#include "attach.h"
#include "recvattach.h"

Include dependency graph for selection.c:

Go to the source code of this file.

Functions
static bool	aa_contains_attach (struct AttachPtrArray *aa, struct AttachPtr *ap)
	Does a working set already include an Attachment?
static void	aa_add_attach (struct AttachPtrArray *aa, struct AttachPtr *ap)
	Add an Attachment to a working set.
static void	aa_add_folded (struct AttachPtrArray *aa, struct AttachCtx *actx, int rindex)
	Add an Attachment, expanding collapsed children.
static int	aa_add_tagged (struct AttachPtrArray *aa, struct AttachCtx *actx)
	Get an array of tagged Attachments.
int	aa_add_selection (struct AttachPtrArray *aa, struct AttachCtx *actx, struct Menu *menu, bool use_tagged, int count)
	Build a working set of Attachments for an action.
int	ba_add_selection (struct BodyArray *ba, struct AttachCtx *actx, struct Menu *menu, bool use_tagged, int count)
	Build a working set of attachment bodies for an action.

Detailed Description

Build a selection of Attachments 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

aa_contains_attach()

static bool aa_contains_attach ( struct AttachPtrArray * aa, struct AttachPtr * ap )

static

Does a working set already include an Attachment?

Parameters

aa	Selected attachments
ap	Candidate attachment

Return values

true	Attachment is selected

Definition at line 44 of file selection.c.

{
  if (!aa || !ap)
    return false;
 
  struct AttachPtr **app = NULL;
  ARRAY_FOREACH(app, aa)
  {
    if (*app == ap)
      return true;
  }
 
  return false;
}

Here is the caller graph for this function:

aa_add_attach()

static void aa_add_attach ( struct AttachPtrArray * aa, struct AttachPtr * ap )

static

Add an Attachment to a working set.

Parameters

aa	Selected attachments
ap	Attachment to add

Definition at line 64 of file selection.c.

{
  if (!aa_contains_attach(aa, ap))
    ARRAY_ADD(aa, ap);
}

Here is the call graph for this function:

Here is the caller graph for this function:

aa_add_folded()

static void aa_add_folded ( struct AttachPtrArray * aa, struct AttachCtx * actx, int rindex )

static

Add an Attachment, expanding collapsed children.

Parameters

aa	Selected attachments
actx	List of Attachments
rindex	Real attachment index

Definition at line 76 of file selection.c.

{
  if (!aa || !actx || (rindex < 0) || (rindex >= actx->idxlen))
    return;
 
  struct AttachPtr *ap = actx->idx[rindex];
  aa_add_attach(aa, ap);
 
  if (!ap->collapsed)
    return;
 
  const int level = ap->level;
  for (int i = rindex + 1; (i < actx->idxlen) && (actx->idx[i]->level > level); i++)
  {
    aa_add_attach(aa, actx->idx[i]);
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

aa_add_tagged()

static int aa_add_tagged ( struct AttachPtrArray * aa, struct AttachCtx * actx )

static

Get an array of tagged Attachments.

Parameters

aa	Empty AttachPtrArray to populate
actx	List of Attachments

Return values

num	Number of selected Attachments
-1	Error

Definition at line 101 of file selection.c.

{
  if (!aa || !actx)
    return -1;
 
  for (int i = 0; i < actx->idxlen; i++)
  {
    if (actx->idx[i]->body->tagged)
      aa_add_folded(aa, actx, i);
  }
 
  return ARRAY_SIZE(aa);
}

Here is the call graph for this function:

Here is the caller graph for this function:

aa_add_selection()

int aa_add_selection	(	struct AttachPtrArray *	aa,
		struct AttachCtx *	actx,
		struct Menu *	menu,
		bool	use_tagged,
		int	count )

Build a working set of Attachments for an action.

Parameters

aa	Empty AttachPtrArray to populate
actx	List of Attachments
menu	Menu
use_tagged	Use tagged attachments
count	Repeat-count (0 or 1 == current selection)

Return values

num	Number of selected Attachments
-1	Error

Definition at line 125 of file selection.c.

{
  if (!aa || !actx || !menu)
    return -1;
 
  if (use_tagged)
    return aa_add_tagged(aa, actx);
 
  const int index = menu_get_index(menu);
  if ((index < 0) || (index >= actx->vcount))
    return -1;
 
  int n = (count > 1) ? count : 1;
  if ((index + n) > actx->vcount)
    n = actx->vcount - index;
 
  for (int i = 0; i < n; i++)
  {
    const int rindex = actx->v2r[index + i];
    if ((rindex < 0) || (rindex >= actx->idxlen))
      return -1;
 
    aa_add_folded(aa, actx, rindex);
  }
 
  return ARRAY_SIZE(aa);
}

Here is the call graph for this function:

Here is the caller graph for this function:

ba_add_selection()

int ba_add_selection	(	struct BodyArray *	ba,
		struct AttachCtx *	actx,
		struct Menu *	menu,
		bool	use_tagged,
		int	count )

Build a working set of attachment bodies for an action.

Parameters

ba	Empty BodyArray to populate
actx	List of Attachments
menu	Menu
use_tagged	Use tagged attachments
count	Repeat-count (0 or 1 == current selection)

Return values

num	Number of selected Attachments
-1	Error

Definition at line 164 of file selection.c.

{
  if (!ba)
    return -1;
 
  struct AttachPtrArray aa = ARRAY_HEAD_INITIALIZER;
  if (aa_add_selection(&aa, actx, menu, use_tagged, count) < 0)
  {
    ARRAY_FREE(&aa);
    return -1;
  }
 
  struct AttachPtr **app = NULL;
  ARRAY_FOREACH(app, &aa)
  {
    ARRAY_ADD(ba, (*app)->body);
  }
 
  const int rc = ARRAY_SIZE(ba);
  ARRAY_FREE(&aa);
  return rc;
}

Here is the call graph for this function:

Here is the caller graph for this function: