group.h File Reference

Handling for email address groups. More...

#include <stdbool.h>
#include <stdint.h>
#include "mutt/lib.h"
#include "address.h"

Include dependency graph for group.h:

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

Go to the source code of this file.

Data Structures
struct	Group
	A set of email addresses. More...
struct	GroupNode
	An element in a GroupList. More...

Macros
#define	MUTT_GROUP   0
	'group' config command
#define	MUTT_UNGROUP   1
	'ungroup' config command

Functions
	STAILQ_HEAD (GroupList, GroupNode)
void	mutt_grouplist_add (struct GroupList *gl, struct Group *group)
	Add a Group to a GroupList.
void	mutt_grouplist_add_addrlist (struct GroupList *gl, struct AddressList *a)
	Add Address list to a GroupList.
int	mutt_grouplist_add_regex (struct GroupList *gl, const char *s, uint16_t flags, struct Buffer *err)
	Add matching Addresses to a GroupList.
void	mutt_grouplist_cleanup (void)
	Free GroupList singleton resource.
void	mutt_grouplist_clear (struct GroupList *gl)
	Clear a GroupList.
void	mutt_grouplist_destroy (struct GroupList *gl)
	Free a GroupList.
void	mutt_grouplist_init (void)
	Initialize the GroupList singleton.
int	mutt_grouplist_remove_addrlist (struct GroupList *gl, struct AddressList *a)
	Remove an AddressList from a GroupList.
int	mutt_grouplist_remove_regex (struct GroupList *gl, const char *s)
	Remove matching addresses from a GroupList.
bool	mutt_group_match (struct Group *g, const char *s)
	Does a string match an entry in a Group?
struct Group *	mutt_pattern_group (const char *pat)
	Match a pattern to a Group.

Detailed Description

Handling for email address groups.

Authors

• Richard Russon
• Pietro Cerutti

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

Macro Definition Documentation

MUTT_GROUP

#define MUTT_GROUP   0

'group' config command

Definition at line 32 of file group.h.

MUTT_UNGROUP

#define MUTT_UNGROUP   1

'ungroup' config command

Definition at line 33 of file group.h.

Function Documentation

STAILQ_HEAD()

STAILQ_HEAD	(	GroupList	,
		GroupNode
	)

mutt_grouplist_add()

void mutt_grouplist_add	(	struct GroupList *	gl,
		struct Group *	group
	)

Add a Group to a GroupList.

Parameters

gl	GroupList to add to
group	Group to add

Definition at line 182 of file group.c.

{
  if (!gl || !group)
    return;
 
  struct GroupNode *np = NULL;
  STAILQ_FOREACH(np, gl, entries)
  {
    if (np->group == group)
      return;
  }
  np = mutt_mem_calloc(1, sizeof(struct GroupNode));
  np->group = group;
  STAILQ_INSERT_TAIL(gl, np, entries);
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_grouplist_add_addrlist()

void mutt_grouplist_add_addrlist	(	struct GroupList *	gl,
		struct AddressList *	al
	)

Add Address list to a GroupList.

Parameters

gl	GroupList to add to
al	Address list to add

Definition at line 271 of file group.c.

{
  if (!gl || !al)
    return;
 
  struct GroupNode *np = NULL;
  STAILQ_FOREACH(np, gl, entries)
  {
    group_add_addrlist(np->group, al);
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_grouplist_add_regex()

int mutt_grouplist_add_regex	(	struct GroupList *	gl,
		const char *	s,
		uint16_t	flags,
		struct Buffer *	err
	)

Add matching Addresses to a GroupList.

Parameters

gl	GroupList to add to
s	Address to match
flags	Flags, e.g. REG_ICASE
err	Buffer for error message

Return values

0	Success
-1	Error

Definition at line 321 of file group.c.

{
  if (!gl || !s)
    return -1;
 
  int rc = 0;
 
  struct GroupNode *np = NULL;
  STAILQ_FOREACH(np, gl, entries)
  {
    rc = group_add_regex(np->group, s, flags, err);
    if (rc)
      return rc;
  }
  return rc;
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_grouplist_cleanup()

void mutt_grouplist_cleanup

(

void

)

Free GroupList singleton resource.

This is called once from init.c when deinitializing the global resources.

Definition at line 107 of file group.c.

{
  mutt_hash_free(&Groups);
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_grouplist_clear()

void mutt_grouplist_clear

(

struct GroupList *

gl

)

Clear a GroupList.

Parameters

gl	GroupList to clear

Definition at line 148 of file group.c.

{
  if (!gl)
    return;
 
  struct GroupNode *np = STAILQ_FIRST(gl);
  struct GroupNode *next = NULL;
  while (np)
  {
    group_remove(np->group);
    next = STAILQ_NEXT(np, entries);
    FREE(&np);
    np = next;
  }
  STAILQ_INIT(gl);
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_grouplist_destroy()

void mutt_grouplist_destroy

(

struct GroupList *

gl

)

Free a GroupList.

Parameters

gl	GroupList to free

Definition at line 202 of file group.c.

{
  if (!gl)
    return;
 
  struct GroupNode *np = STAILQ_FIRST(gl);
  struct GroupNode *next = NULL;
  while (np)
  {
    next = STAILQ_NEXT(np, entries);
    FREE(&np);
    np = next;
  }
  STAILQ_INIT(gl);
}

Here is the caller graph for this function:

mutt_grouplist_init()

void mutt_grouplist_init

(

void

)

Initialize the GroupList singleton.

This is called once from init.c when initializing the global structures.

Definition at line 95 of file group.c.

{
  Groups = mutt_hash_new(1031, MUTT_HASH_NO_FLAGS);
 
  mutt_hash_set_destructor(Groups, group_hash_free, 0);
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_grouplist_remove_addrlist()

int mutt_grouplist_remove_addrlist	(	struct GroupList *	gl,
		struct AddressList *	al
	)

Remove an AddressList from a GroupList.

Parameters

gl	GroupList to remove from
al	AddressList to remove

Return values

0	Success
-1	Error

Definition at line 290 of file group.c.

{
  if (!gl || !al)
    return -1;
 
  struct GroupNode *gnp = NULL;
  STAILQ_FOREACH(gnp, gl, entries)
  {
    struct Address *a = NULL;
    TAILQ_FOREACH(a, al, entries)
    {
      mutt_addrlist_remove(&gnp->group->al, buf_string(a->mailbox));
    }
    if (empty_group(gnp->group))
    {
      group_remove(gnp->group);
    }
  }
 
  return 0;
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_grouplist_remove_regex()

int mutt_grouplist_remove_regex	(	struct GroupList *	gl,
		const char *	s
	)

Remove matching addresses from a GroupList.

Parameters

gl	GroupList to remove from
s	Address to match

Return values

0	Success
-1	Error

Definition at line 346 of file group.c.

{
  if (!gl || !s)
    return -1;
 
  int rc = 0;
  struct GroupNode *np = NULL;
  STAILQ_FOREACH(np, gl, entries)
  {
    rc = group_remove_regex(np->group, s);
    if (empty_group(np->group))
      group_remove(np->group);
    if (rc)
      return rc;
  }
  return rc;
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_group_match()

bool mutt_group_match	(	struct Group *	g,
		const char *	s
	)

Does a string match an entry in a Group?

Parameters

g	Group to match against
s	String to match

Return values

true	There's a match

Definition at line 370 of file group.c.

{
  if (!g || !s)
    return false;
 
  if (mutt_regexlist_match(&g->rs, s))
    return true;
  struct Address *a = NULL;
  TAILQ_FOREACH(a, &g->al, entries)
  {
    if (a->mailbox && mutt_istr_equal(s, buf_string(a->mailbox)))
      return true;
  }
 
  return false;
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_pattern_group()

struct Group * mutt_pattern_group

(

const char *

pat

)

Match a pattern to a Group.

Parameters

pat	Pattern to match

Return values

ptr	Matching Group, or new Group (if no match)

Definition at line 117 of file group.c.

{
  if (!pat)
    return NULL;
 
  struct Group *g = mutt_hash_find(Groups, pat);
  if (!g)
  {
    mutt_debug(LL_DEBUG2, "Creating group %s\n", pat);
    g = group_new(pat);
    mutt_hash_insert(Groups, g->name, g);
  }
 
  return g;
}

Here is the call graph for this function:

Here is the caller graph for this function: