functions.h File Reference

Alias functions. More...

#include <stdbool.h>

Include dependency graph for functions.h:

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

Go to the source code of this file.

Data Structures
struct	AliasFunction
	A NeoMutt function. More...

Typedefs
typedef int(*	alias_function_t) (struct AliasMenuData *wdata, int op)

Functions
void	alias_array_sort (struct AliasViewArray *ava, const struct ConfigSubset *sub)
	Sort and reindex an AliasViewArray.
int	alias_function_dispatcher (struct MuttWindow *win, int op)
	Perform a Alias function - Implements function_dispatcher_t -.
bool	alias_to_addrlist (struct AddressList *al, struct Alias *alias)
	Turn an Alias into an AddressList.
int	query_run (const char *s, bool verbose, struct AliasList *al, const struct ConfigSubset *sub)
	Run an external program to find Addresses.

Detailed Description

Alias functions.

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

Typedef Documentation

alias_function_t

typedef int(* alias_function_t) (struct AliasMenuData *wdata, int op)

Definition at line 46 of file functions.h.

Function Documentation

alias_array_sort()

void alias_array_sort	(	struct AliasViewArray *	ava,
		const struct ConfigSubset *	sub
	)

Sort and reindex an AliasViewArray.

Parameters

ava	Array of Aliases
sub	Config items

Definition at line 235 of file sort.c.

{
  if (!ava || ARRAY_EMPTY(ava))
    return;
 
  short c_sort_alias = cs_subset_sort(sub, "alias_sort");
  if (c_sort_alias == ALIAS_SORT_ALIAS)
  {
    struct AliasView *av = ARRAY_GET(ava, 0);
    struct Alias *a = av->alias;
 
    if (!a->name) // We've got a Query
      c_sort_alias = ALIAS_SORT_NAME;
  }
 
  bool sort_reverse = (c_sort_alias & SORT_REVERSE);
  ARRAY_SORT(ava, alias_get_sort_function(c_sort_alias), &sort_reverse);
 
  struct AliasView *avp = NULL;
  ARRAY_FOREACH(avp, ava)
  {
    avp->num = ARRAY_FOREACH_IDX;
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

alias_to_addrlist()

bool alias_to_addrlist	(	struct AddressList *	al,
		struct Alias *	alias
	)

Turn an Alias into an AddressList.

Parameters

al	AddressList to fill (must be empty)
alias	Alias to use

Return values

true

Success

Definition at line 120 of file dlg_query.c.

{
  if (!al || !TAILQ_EMPTY(al) || !alias)
    return false;
 
  mutt_addrlist_copy(al, &alias->addr, false);
  if (!TAILQ_EMPTY(al))
  {
    struct Address *first = TAILQ_FIRST(al);
    struct Address *second = TAILQ_NEXT(first, entries);
    if (!second && !first->personal)
    {
      first->personal = buf_new(alias->name);
    }
 
    mutt_addrlist_to_intl(al, NULL);
  }
 
  return true;
}

Here is the call graph for this function:

Here is the caller graph for this function:

query_run()

int query_run	(	const char *	s,
		bool	verbose,
		struct AliasList *	al,
		const struct ConfigSubset *	sub
	)

Run an external program to find Addresses.

Parameters

s	String to match
verbose	If true, print progress messages
al	Alias list to fill
sub	Config items

Return values

0	Success
-1	Error

Definition at line 189 of file dlg_query.c.

{
  FILE *fp = NULL;
  char *buf = NULL;
  size_t buflen;
  char *msg = NULL;
  size_t msglen = 0;
  char *tok = NULL;
  char *next_tok = NULL;
  struct Buffer *cmd = buf_pool_get();
 
  const char *const c_query_command = cs_subset_string(sub, "query_command");
  buf_file_expand_fmt_quote(cmd, c_query_command, s);
 
  pid_t pid = filter_create(buf_string(cmd), NULL, &fp, NULL, EnvList);
  if (pid < 0)
  {
    mutt_debug(LL_DEBUG1, "unable to fork command: %s\n", buf_string(cmd));
    buf_pool_release(&cmd);
    return -1;
  }
  buf_pool_release(&cmd);
 
  if (verbose)
    mutt_message(_("Waiting for response..."));
 
  struct Buffer *addr = buf_pool_get();
  /* The query protocol first reads one NL-terminated line. If an error
   * occurs, this is assumed to be an error message. Otherwise it's ignored. */
  msg = mutt_file_read_line(msg, &msglen, fp, NULL, MUTT_RL_NO_FLAGS);
  while ((buf = mutt_file_read_line(buf, &buflen, fp, NULL, MUTT_RL_NO_FLAGS)))
  {
    tok = buf;
    next_tok = strchr(tok, '\t');
    if (next_tok)
      *next_tok++ = '\0';
 
    if (*tok == '\0')
      continue;
 
    struct Alias *alias = alias_new();
 
    if (next_tok)
    {
      tok = next_tok;
      next_tok = strchr(tok, '\t');
      if (next_tok)
        *next_tok++ = '\0';
 
      buf_printf(addr, "%s <%s>", tok, buf);
      mutt_addrlist_parse(&alias->addr, buf_string(addr));
 
      parse_alias_comments(alias, next_tok);
    }
    else
    {
      mutt_addrlist_parse(&alias->addr, buf); // Email address
    }
 
    TAILQ_INSERT_TAIL(al, alias, entries);
  }
  buf_pool_release(&addr);
 
  FREE(&buf);
  mutt_file_fclose(&fp);
  if (filter_wait(pid))
  {
    mutt_debug(LL_DEBUG1, "Error: %s\n", msg);
    if (verbose)
      mutt_error("%s", msg);
  }
  else
  {
    if (verbose)
      mutt_message("%s", msg);
  }
  FREE(&msg);
 
  return 0;
}

Here is the call graph for this function:

Here is the caller graph for this function: