lib.h File Reference

GUI display the mailboxes in a side panel. More...

#include <stdbool.h>
#include <stdint.h>
#include "core/lib.h"
#include "attach.h"
#include "commands.h"
#include "expando/lib.h"
#include "mutt_attach.h"
#include "recvattach.h"

Include dependency graph for lib.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
int	attach_body_count (struct Body *b, bool recurse)
	Count bodies.
bool	attach_body_parent (struct Body *start, struct Body *start_parent, struct Body *body, struct Body **body_parent)
	Find the parent of a body.
struct Body *	attach_body_ancestor (struct Body *start, struct Body *body, const char *subtype)
	Find the ancestor of a body with specified subtype.
bool	attach_body_previous (struct Body *start, struct Body *body, struct Body **previous)
	Find the previous body of a body.
enum CommandResult	parse_attachments (struct Buffer *buf, struct Buffer *s, intptr_t data, struct Buffer *err)
	Parse the 'attachments' command - Implements Command::parse() -.
enum CommandResult	parse_unattachments (struct Buffer *buf, struct Buffer *s, intptr_t data, struct Buffer *err)
	Parse the 'unattachments' command - Implements Command::parse() -.

Variables
const struct ExpandoRenderCallback	AttachRenderCallbacks []
	Callbacks for Attachment Expandos.

Detailed Description

GUI display the mailboxes in a side panel.

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 lib.h.

Function Documentation

attach_body_count()

int attach_body_count	(	struct Body *	body,
		bool	recurse )

Count bodies.

Parameters

body	Body to start counting from
recurse	Whether to recurse into groups or not

Return values

num	Number of bodies
-1	Failure

Definition at line 42 of file lib.c.

{
  if (!body)
    return -1;
 
  int bodies = 0;
 
  for (struct Body *b = body; b; b = b->next)
  {
    bodies++;
    if (recurse)
    {
      if (b->parts)
        bodies += attach_body_count(b->parts, true);
    }
  }
 
  return bodies;
}

Here is the call graph for this function:

Here is the caller graph for this function:

attach_body_parent()

bool attach_body_parent	(	struct Body *	start,
		struct Body *	start_parent,
		struct Body *	body,
		struct Body **	body_parent )

Find the parent of a body.

Parameters

[in]	start	Body to start search from
[in]	start_parent	Parent of start Body pointer (or NULL if none)
[in]	body	Body to find parent of
[out]	body_parent	Body Parent if found

Return values

true	Parent body found
false	Parent body not found

Definition at line 71 of file lib.c.

{
  if (!start || !body)
    return false;
 
  struct Body *b = start;
 
  if (b->parts)
  {
    if (b->parts == body)
    {
      *body_parent = b;
      return true;
    }
  }
  while (b)
  {
    if (b == body)
    {
      *body_parent = start_parent;
      if (start_parent)
        return true;
      else
        return false;
    }
    if (b->parts)
    {
      if (attach_body_parent(b->parts, b, body, body_parent))
        return true;
    }
    b = b->next;
  }
 
  return false;
}

Here is the call graph for this function:

Here is the caller graph for this function:

attach_body_ancestor()

struct Body * attach_body_ancestor	(	struct Body *	start,
		struct Body *	body,
		const char *	subtype )

Find the ancestor of a body with specified subtype.

Parameters

[in]	start	Body to start search from
[in]	body	Body to find ancestor of
[in]	subtype	Mime subtype of ancestor to find

Return values

ptr	Body ancestor if found
NULL	If ancestor body not found

Definition at line 116 of file lib.c.

{
  if (!start || !body)
    return NULL;
 
  struct Body *b = body;
  struct Body *b_parent = NULL;
 
  while (attach_body_parent(start, NULL, b, &b_parent))
  {
    if (mutt_str_equal(subtype, b_parent->subtype))
      return b_parent;
    b = b_parent;
  }
 
  return NULL;
}

Here is the call graph for this function:

Here is the caller graph for this function:

attach_body_previous()

bool attach_body_previous	(	struct Body *	start,
		struct Body *	body,
		struct Body **	previous )

Find the previous body of a body.

Parameters

[in]	start	Body to start search from
[in]	body	Body to find previous body of
[out]	previous	Previous Body if found

Return values

true	Previous body found
false	Previous body not found

Definition at line 142 of file lib.c.

{
  if (!start || !body)
    return false;
 
  struct Body *b = start;
 
  while (b)
  {
    if (b->next == body)
    {
      *previous = b;
      return true;
    }
    if (b->parts)
    {
      if (attach_body_previous(b->parts, body, previous))
        return true;
    }
    b = b->next;
  }
 
  return false;
}

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

AttachRenderCallbacks

const struct ExpandoRenderCallback AttachRenderCallbacks[]

extern

Callbacks for Attachment Expandos.

See also

AttachFormatDef, ExpandoDataAttach, ExpandoDataBody, ExpandoDataGlobal

Definition at line 375 of file expando.c.

                                                             {
  // clang-format off
 
  { ED_ATTACH, ED_ATT_CHARSET,          attach_charset,        NULL },
  { ED_ATTACH, ED_ATT_NUMBER,           NULL,                  attach_number_num },
  { ED_ATTACH, ED_ATT_TREE,             attach_tree,           NULL },
 
  { ED_BODY,   ED_BOD_CHARSET_CONVERT,  body_charset_convert,  NULL },
  { ED_BODY,   ED_BOD_DELETED,          body_deleted,          body_deleted_num },
  { ED_BODY,   ED_BOD_DESCRIPTION,      body_description,      NULL },
  { ED_BODY,   ED_BOD_MIME_ENCODING,    body_mime_encoding,    NULL },
  { ED_BODY,   ED_BOD_FILE,             body_file,             NULL },
  { ED_BODY,   ED_BOD_FILE_DISPOSITION, body_file_disposition, NULL },
  { ED_BODY,   ED_BOD_DISPOSITION,      body_disposition,      NULL },
  { ED_BODY,   ED_BOD_MIME_MAJOR,       body_mime_major,       NULL },
  { ED_BODY,   ED_BOD_MIME_MINOR,       body_mime_minor,       NULL },
  { ED_BODY,   ED_BOD_ATTACH_QUALIFIES, body_attach_qualifies, body_attach_qualifies_num },
  { ED_BODY,   ED_BOD_FILE_SIZE,        body_file_size,        body_file_size_num },
  { ED_BODY,   ED_BOD_TAGGED,           body_tagged,           body_tagged_num },
  { ED_BODY,   ED_BOD_UNLINK,           body_unlink,           body_unlink_num },
  { ED_BODY,   ED_BOD_ATTACH_COUNT,     NULL,                  body_attach_count_num },
 
  { -1, -1, NULL, NULL },
  // clang-format on
};