Function Dispatcher API

Prototype for a Function Dispatcher. More...

Collaboration diagram for Function Dispatcher API:

Modules
	Alias Function API
	Prototype for a Alias Function.
	Attachment Function API
	Prototype for an Attachment Function.
	Autocrypt Function API
	Prototype for a Autocrypt Function.
	Compose Function API
	Prototype for a Compose Function.
	Preview Function API
	Prototype for a Preview Function.
	Envelope Function API
	Prototype for a Envelope Function.
	Global Function API
	Prototype for a Global Function.
	History Function API
	Prototype for a History Function.
	Index Function API
	Prototype for an Index Function.
	Menu Function API
	Prototype for a Menu Function.
	Gpgme Function API
	Prototype for a Gpgme Function.
	Pgp Function API
	Prototype for a Pgp Function.
	Smime Function API
	Prototype for a Smime Function.
	Pager Function API
	Prototype for a Pager Function.
	Pattern Function API
	Prototype for a Pattern Function.
	Postpone Function API
	Prototype for a Postpone Function.
	Sidebar Function API
	Prototype for a Sidebar Function.

Functions
int	alias_function_dispatcher (struct MuttWindow *win, int op)
	Perform a Alias function - Implements function_dispatcher_t -.
int	attach_function_dispatcher (struct MuttWindow *win, int op)
	Perform a Attach function - Implements function_dispatcher_t -.
int	autocrypt_function_dispatcher (struct MuttWindow *win, int op)
	Perform a Autocrypt function - Implements function_dispatcher_t -.
int	compose_function_dispatcher (struct MuttWindow *win, int op)
	Perform a Compose function - Implements function_dispatcher_t -.
int	preview_function_dispatcher (struct MuttWindow *win, int op)
	Perform a preview function - Implements function_dispatcher_t -.
int	enter_function_dispatcher (struct MuttWindow *win, int op)
	Perform an Enter function - Implements function_dispatcher_t -.
int	env_function_dispatcher (struct MuttWindow *win, int op)
	Perform an Envelope function - Implements function_dispatcher_t -.
int	global_function_dispatcher (struct MuttWindow *win, int op)
	Perform a Global function - Implements function_dispatcher_t -.
int	history_function_dispatcher (struct MuttWindow *win, int op)
	Perform a History function - Implements function_dispatcher_t -.
int	index_function_dispatcher (struct MuttWindow *win, int op)
	Perform an Index function - Implements function_dispatcher_t -.
int	menu_function_dispatcher (struct MuttWindow *win, int op)
	Perform a Menu function - Implements function_dispatcher_t -.
int	menu_tagging_dispatcher (struct MuttWindow *win, int op)
	Perform tagging operations on the Menu - Implements function_dispatcher_t -.
int	gpgme_function_dispatcher (struct MuttWindow *win, int op)
	Perform a Gpgme function - Implements function_dispatcher_t -.
int	pgp_function_dispatcher (struct MuttWindow *win, int op)
	Perform a Pgp function - Implements function_dispatcher_t -.
int	smime_function_dispatcher (struct MuttWindow *win, int op)
	Perform a Smime function - Implements function_dispatcher_t -.
int	pager_function_dispatcher (struct MuttWindow *win, int op)
	Perform a Pager function - Implements function_dispatcher_t -.
int	pattern_function_dispatcher (struct MuttWindow *win, int op)
	Perform a Pattern function - Implements function_dispatcher_t -.
int	postpone_function_dispatcher (struct MuttWindow *win, int op)
	Perform a Postpone function - Implements function_dispatcher_t -.
int	sb_function_dispatcher (struct MuttWindow *win, int op)
	Perform a Sidebar function - Implements function_dispatcher_t -.

Detailed Description

Prototype for a Function Dispatcher.

Perform a NeoMutt function

Parameters

win	Window
op	Operation to perform, e.g. OP_MAIN_LIMIT

Return values

num	FunctionRetval

Function Documentation

alias_function_dispatcher()

int alias_function_dispatcher	(	struct MuttWindow *	win,
		int	op
	)

Perform a Alias function - Implements function_dispatcher_t -.

Definition at line 467 of file functions.c.

{
  // The Dispatcher may be called on any Window in the Dialog
  struct MuttWindow *dlg = dialog_find(win);
  if (!dlg || !dlg->wdata)
    return FR_ERROR;
 
  struct Menu *menu = dlg->wdata;
  struct AliasMenuData *mdata = menu->mdata;
 
  int rc = FR_UNKNOWN;
  for (size_t i = 0; AliasFunctions[i].op != OP_NULL; i++)
  {
    const struct AliasFunction *fn = &AliasFunctions[i];
    if (fn->op == op)
    {
      rc = fn->function(mdata, op);
      break;
    }
  }
 
  if (rc == FR_UNKNOWN) // Not our function
    return rc;
 
  const char *result = dispatcher_get_retval_name(rc);
  mutt_debug(LL_DEBUG1, "Handled %s (%d) -> %s\n", opcodes_get_name(op), op, NONULL(result));
 
  return rc;
}

Here is the call graph for this function:

Here is the caller graph for this function:

attach_function_dispatcher()

int attach_function_dispatcher	(	struct MuttWindow *	win,
		int	op
	)

Perform a Attach function - Implements function_dispatcher_t -.

Definition at line 711 of file functions.c.

{
  // The Dispatcher may be called on any Window in the Dialog
  struct MuttWindow *dlg = dialog_find(win);
  if (!dlg || !dlg->wdata)
    return FR_ERROR;
 
  struct Menu *menu = dlg->wdata;
  struct AttachPrivateData *priv = menu->mdata;
  if (!priv)
    return FR_ERROR;
 
  int rc = FR_UNKNOWN;
  for (size_t i = 0; AttachFunctions[i].op != OP_NULL; i++)
  {
    const struct AttachFunction *fn = &AttachFunctions[i];
    if (fn->op == op)
    {
      rc = fn->function(priv, op);
      break;
    }
  }
 
  return rc;
}

Here is the call graph for this function:

Here is the caller graph for this function:

autocrypt_function_dispatcher()

int autocrypt_function_dispatcher	(	struct MuttWindow *	win,
		int	op
	)

Perform a Autocrypt function - Implements function_dispatcher_t -.

Definition at line 214 of file functions.c.

{
  // The Dispatcher may be called on any Window in the Dialog
  struct MuttWindow *dlg = dialog_find(win);
  if (!dlg || !dlg->wdata)
    return FR_ERROR;
 
  struct Menu *menu = dlg->wdata;
  struct AutocryptData *ad = menu->mdata;
 
  int rc = FR_UNKNOWN;
  for (size_t i = 0; AutocryptFunctions[i].op != OP_NULL; i++)
  {
    const struct AutocryptFunction *fn = &AutocryptFunctions[i];
    if (fn->op == op)
    {
      rc = fn->function(ad, op);
      break;
    }
  }
 
  if (rc == FR_UNKNOWN) // Not our function
    return rc;
 
  const char *result = dispatcher_get_retval_name(rc);
  mutt_debug(LL_DEBUG1, "Handled %s (%d) -> %s\n", opcodes_get_name(op), op, NONULL(result));
 
  return rc;
}

Here is the call graph for this function:

Here is the caller graph for this function:

compose_function_dispatcher()

int compose_function_dispatcher	(	struct MuttWindow *	win,
		int	op
	)

Perform a Compose function - Implements function_dispatcher_t -.

Definition at line 2143 of file functions.c.

{
  // The Dispatcher may be called on any Window in the Dialog
  struct MuttWindow *dlg = dialog_find(win);
  if (!dlg || !dlg->wdata)
    return FR_ERROR;
 
  int rc = FR_UNKNOWN;
  for (size_t i = 0; ComposeFunctions[i].op != OP_NULL; i++)
  {
    const struct ComposeFunction *fn = &ComposeFunctions[i];
    if (fn->op == op)
    {
      struct ComposeSharedData *shared = dlg->wdata;
      rc = fn->function(shared, op);
      break;
    }
  }
 
  if (rc == FR_UNKNOWN) // Not our function
    return rc;
 
  const char *result = dispatcher_get_retval_name(rc);
  mutt_debug(LL_DEBUG1, "Handled %s (%d) -> %s\n", opcodes_get_name(op), op, NONULL(result));
 
  return rc;
}

Here is the call graph for this function:

Here is the caller graph for this function:

preview_function_dispatcher()

int preview_function_dispatcher	(	struct MuttWindow *	win,
		int	op
	)

Perform a preview function - Implements function_dispatcher_t -.

Definition at line 405 of file preview.c.

{
  if (!win || !win->wdata)
    return FR_UNKNOWN;
 
  int rc = FR_UNKNOWN;
  for (size_t i = 0; PreviewFunctions[i].op != OP_NULL; i++)
  {
    const struct PreviewFunction *fn = &PreviewFunctions[i];
    if (fn->op == op)
    {
      struct PreviewWindowData *wdata = win->wdata;
      rc = fn->function(wdata, op);
      break;
    }
  }
 
  if (rc == FR_UNKNOWN) // Not our function
    return rc;
 
  const char *result = dispatcher_get_retval_name(rc);
  mutt_debug(LL_DEBUG1, "Handled %s (%d) -> %s\n", opcodes_get_name(op), op, NONULL(result));
 
  return rc;
}

Here is the call graph for this function:

Here is the caller graph for this function:

enter_function_dispatcher()

int enter_function_dispatcher	(	struct MuttWindow *	win,
		int	op
	)

Perform an Enter function - Implements function_dispatcher_t -.

Definition at line 482 of file functions.c.

{
  if (!win || !win->wdata)
    return FR_UNKNOWN;
 
  struct EnterWindowData *wdata = win->wdata;
 
  int rc = FR_UNKNOWN;
  for (size_t i = 0; EnterFunctions[i].op != OP_NULL; i++)
  {
    const struct EnterFunction *fn = &EnterFunctions[i];
    if (fn->op == op)
    {
      rc = fn->function(wdata, op);
      break;
    }
  }
 
  if (rc == FR_UNKNOWN) // Not our function
    return rc;
 
  const char *result = dispatcher_get_retval_name(rc);
  mutt_debug(LL_DEBUG1, "Handled %s (%d) -> %s\n", opcodes_get_name(op), op, NONULL(result));
 
  return rc;
}

Here is the call graph for this function:

Here is the caller graph for this function:

env_function_dispatcher()

int env_function_dispatcher	(	struct MuttWindow *	win,
		int	op
	)

Perform an Envelope function - Implements function_dispatcher_t -.

Definition at line 530 of file functions.c.

{
  if (!win || !win->wdata)
    return FR_UNKNOWN;
 
  int rc = FR_UNKNOWN;
  for (size_t i = 0; EnvelopeFunctions[i].op != OP_NULL; i++)
  {
    const struct EnvelopeFunction *fn = &EnvelopeFunctions[i];
    if (fn->op == op)
    {
      struct EnvelopeWindowData *wdata = win->wdata;
      rc = fn->function(wdata, op);
      break;
    }
  }
 
  if (rc == FR_UNKNOWN) // Not our function
    return rc;
 
  const char *result = dispatcher_get_retval_name(rc);
  mutt_debug(LL_DEBUG1, "Handled %s (%d) -> %s\n", opcodes_get_name(op), op, NONULL(result));
 
  return rc;
}

Here is the call graph for this function:

Here is the caller graph for this function:

global_function_dispatcher()

int global_function_dispatcher	(	struct MuttWindow *	win,
		int	op
	)

Perform a Global function - Implements function_dispatcher_t -.

Note

win is not used

Definition at line 172 of file global.c.

{
  int rc = FR_UNKNOWN;
  for (size_t i = 0; GlobalFunctions[i].op != OP_NULL; i++)
  {
    const struct GlobalFunction *fn = &GlobalFunctions[i];
    if (fn->op == op)
    {
      rc = fn->function(op);
      break;
    }
  }
 
  if (rc == FR_UNKNOWN) // Not our function
    return rc;
 
  const char *result = dispatcher_get_retval_name(rc);
  mutt_debug(LL_DEBUG1, "Handled %s (%d) -> %s\n", opcodes_get_name(op), op, NONULL(result));
 
  return FR_SUCCESS; // Whatever the outcome, we handled it
}

Here is the call graph for this function:

Here is the caller graph for this function:

history_function_dispatcher()

int history_function_dispatcher	(	struct MuttWindow *	win,
		int	op
	)

Perform a History function - Implements function_dispatcher_t -.

Definition at line 79 of file functions.c.

{
  // The Dispatcher may be called on any Window in the Dialog
  struct MuttWindow *dlg = dialog_find(win);
  if (!dlg || !dlg->wdata)
    return FR_ERROR;
 
  struct Menu *menu = dlg->wdata;
  struct HistoryData *hd = menu->mdata;
 
  int rc = FR_UNKNOWN;
  for (size_t i = 0; HistoryFunctions[i].op != OP_NULL; i++)
  {
    const struct HistoryFunction *fn = &HistoryFunctions[i];
    if (fn->op == op)
    {
      rc = fn->function(hd, op);
      break;
    }
  }
 
  if (rc == FR_UNKNOWN) // Not our function
    return rc;
 
  const char *result = dispatcher_get_retval_name(rc);
  mutt_debug(LL_DEBUG1, "Handled %s (%d) -> %s\n", opcodes_get_name(op), op, NONULL(result));
 
  return rc;
}

Here is the call graph for this function:

Here is the caller graph for this function:

index_function_dispatcher()

int index_function_dispatcher	(	struct MuttWindow *	win,
		int	op
	)

Perform an Index function - Implements function_dispatcher_t -.

Definition at line 3259 of file functions.c.

{
  // The Dispatcher may be called on any Window in the Dialog
  struct MuttWindow *dlg = dialog_find(win);
  if (!dlg || !dlg->wdata || !win->parent || !win->parent->wdata)
    return FR_ERROR;
 
  struct IndexPrivateData *priv = win->parent->wdata;
  struct IndexSharedData *shared = dlg->wdata;
 
  int rc = FR_UNKNOWN;
  for (size_t i = 0; IndexFunctions[i].op != OP_NULL; i++)
  {
    const struct IndexFunction *fn = &IndexFunctions[i];
    if (fn->op == op)
    {
      if (!prereq(shared, priv->menu, fn->flags))
      {
        rc = FR_ERROR;
        break;
      }
      rc = fn->function(shared, priv, op);
      break;
    }
  }
 
  if (rc == FR_UNKNOWN) // Not our function
    return rc;
 
  const char *result = dispatcher_get_retval_name(rc);
  mutt_debug(LL_DEBUG1, "Handled %s (%d) -> %s\n", opcodes_get_name(op), op, NONULL(result));
 
  return rc;
}

Here is the call graph for this function:

Here is the caller graph for this function:

menu_function_dispatcher()

int menu_function_dispatcher	(	struct MuttWindow *	win,
		int	op
	)

Perform a Menu function - Implements function_dispatcher_t -.

Definition at line 318 of file functions.c.

{
  if (!win || !win->wdata)
    return FR_UNKNOWN;
 
  struct Menu *menu = win->wdata;
 
  int rc = FR_UNKNOWN;
  for (size_t i = 0; MenuFunctions[i].op != OP_NULL; i++)
  {
    const struct MenuFunction *fn = &MenuFunctions[i];
    if (fn->op == op)
    {
      rc = fn->function(menu, op);
      break;
    }
  }
 
  if (rc == FR_UNKNOWN) // Not our function
    return rc;
 
  const char *result = dispatcher_get_retval_name(rc);
  mutt_debug(LL_DEBUG1, "Handled %s (%d) -> %s\n", opcodes_get_name(op), op, NONULL(result));
 
  return rc;
}

Here is the call graph for this function:

Here is the caller graph for this function:

menu_tagging_dispatcher()

int menu_tagging_dispatcher	(	struct MuttWindow *	win,
		int	op
	)

Perform tagging operations on the Menu - Implements function_dispatcher_t -.

Definition at line 230 of file tagging.c.

{
  struct Menu *menu = win->wdata;
 
  switch (op)
  {
    case OP_END_COND:
      return op_end_cond(menu, op);
    case OP_TAG:
      return op_tag(menu, op);
    case OP_TAG_PREFIX:
      return op_tag_prefix(menu, op);
    case OP_TAG_PREFIX_COND:
      return op_tag_prefix_cond(menu, op);
    case OP_ABORT:
      return menu_abort(menu);
    case OP_TIMEOUT:
      return menu_timeout(menu);
    default:
      return menu_other(menu);
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

gpgme_function_dispatcher()

int gpgme_function_dispatcher	(	struct MuttWindow *	win,
		int	op
	)

Perform a Gpgme function - Implements function_dispatcher_t -.

Definition at line 856 of file gpgme_functions.c.

{
  // The Dispatcher may be called on any Window in the Dialog
  struct MuttWindow *dlg = dialog_find(win);
  if (!dlg || !dlg->wdata)
    return FR_ERROR;
 
  struct Menu *menu = dlg->wdata;
  struct GpgmeData *gd = menu->mdata;
 
  int rc = FR_UNKNOWN;
  for (size_t i = 0; GpgmeFunctions[i].op != OP_NULL; i++)
  {
    const struct GpgmeFunction *fn = &GpgmeFunctions[i];
    if (fn->op == op)
    {
      rc = fn->function(gd, op);
      break;
    }
  }
 
  if (rc == FR_UNKNOWN) // Not our function
    return rc;
 
  const char *result = dispatcher_get_retval_name(rc);
  mutt_debug(LL_DEBUG1, "Handled %s (%d) -> %s\n", opcodes_get_name(op), op, NONULL(result));
 
  return rc;
}

Here is the call graph for this function:

Here is the caller graph for this function:

pgp_function_dispatcher()

int pgp_function_dispatcher	(	struct MuttWindow *	win,
		int	op
	)

Perform a Pgp function - Implements function_dispatcher_t -.

Definition at line 221 of file pgp_functions.c.

{
  // The Dispatcher may be called on any Window in the Dialog
  struct MuttWindow *dlg = dialog_find(win);
  if (!dlg || !dlg->wdata)
    return FR_ERROR;
 
  struct Menu *menu = dlg->wdata;
  struct PgpData *pd = menu->mdata;
 
  int rc = FR_UNKNOWN;
  for (size_t i = 0; PgpFunctions[i].op != OP_NULL; i++)
  {
    const struct PgpFunction *fn = &PgpFunctions[i];
    if (fn->op == op)
    {
      rc = fn->function(pd, op);
      break;
    }
  }
 
  if (rc == FR_UNKNOWN) // Not our function
    return rc;
 
  const char *result = dispatcher_get_retval_name(rc);
  mutt_debug(LL_DEBUG1, "Handled %s (%d) -> %s\n", opcodes_get_name(op), op, NONULL(result));
 
  return rc;
}

Here is the call graph for this function:

Here is the caller graph for this function:

smime_function_dispatcher()

int smime_function_dispatcher	(	struct MuttWindow *	win,
		int	op
	)

Perform a Smime function - Implements function_dispatcher_t -.

Definition at line 109 of file smime_functions.c.

{
  // The Dispatcher may be called on any Window in the Dialog
  struct MuttWindow *dlg = dialog_find(win);
  if (!dlg || !dlg->wdata)
    return FR_ERROR;
 
  struct Menu *menu = dlg->wdata;
  struct SmimeData *sd = menu->mdata;
 
  int rc = FR_UNKNOWN;
  for (size_t i = 0; SmimeFunctions[i].op != OP_NULL; i++)
  {
    const struct SmimeFunction *fn = &SmimeFunctions[i];
    if (fn->op == op)
    {
      rc = fn->function(sd, op);
      break;
    }
  }
 
  if (rc == FR_UNKNOWN) // Not our function
    return rc;
 
  const char *result = dispatcher_get_retval_name(rc);
  mutt_debug(LL_DEBUG1, "Handled %s (%d) -> %s\n", opcodes_get_name(op), op, NONULL(result));
 
  return rc;
}

Here is the call graph for this function:

Here is the caller graph for this function:

pager_function_dispatcher()

int pager_function_dispatcher	(	struct MuttWindow *	win,
		int	op
	)

Perform a Pager function - Implements function_dispatcher_t -.

Definition at line 1126 of file functions.c.

{
  if (!win)
  {
    mutt_error("%s", _(Not_available_in_this_menu));
    return FR_ERROR;
  }
 
  struct PagerPrivateData *priv = win->parent->wdata;
  if (!priv)
    return FR_ERROR;
 
  struct MuttWindow *dlg = dialog_find(win);
  if (!dlg || !dlg->wdata)
    return FR_ERROR;
 
  int rc = FR_UNKNOWN;
  for (size_t i = 0; PagerFunctions[i].op != OP_NULL; i++)
  {
    const struct PagerFunction *fn = &PagerFunctions[i];
    if (fn->op == op)
    {
      struct IndexSharedData *shared = dlg->wdata;
      rc = fn->function(shared, priv, op);
      break;
    }
  }
 
  if (rc == FR_UNKNOWN) // Not our function
    return rc;
 
  const char *result = dispatcher_get_retval_name(rc);
  mutt_debug(LL_DEBUG1, "Handled %s (%d) -> %s\n", opcodes_get_name(op), op, NONULL(result));
 
  return rc;
}

Here is the call graph for this function:

Here is the caller graph for this function:

pattern_function_dispatcher()

int pattern_function_dispatcher	(	struct MuttWindow *	win,
		int	op
	)

Perform a Pattern function - Implements function_dispatcher_t -.

Definition at line 81 of file functions.c.

{
  // The Dispatcher may be called on any Window in the Dialog
  struct MuttWindow *dlg = dialog_find(win);
  if (!dlg || !dlg->wdata)
    return FR_ERROR;
 
  struct Menu *menu = dlg->wdata;
  struct PatternData *pd = menu->mdata;
 
  int rc = FR_UNKNOWN;
  for (size_t i = 0; PatternFunctions[i].op != OP_NULL; i++)
  {
    const struct PatternFunction *fn = &PatternFunctions[i];
    if (fn->op == op)
    {
      rc = fn->function(pd, op);
      break;
    }
  }
 
  if (rc == FR_UNKNOWN) // Not our function
    return rc;
 
  const char *result = dispatcher_get_retval_name(rc);
  mutt_debug(LL_DEBUG1, "Handled %s (%d) -> %s\n", opcodes_get_name(op), op, NONULL(result));
 
  return rc;
}

Here is the call graph for this function:

Here is the caller graph for this function:

postpone_function_dispatcher()

int postpone_function_dispatcher	(	struct MuttWindow *	win,
		int	op
	)

Perform a Postpone function - Implements function_dispatcher_t -.

Definition at line 177 of file functions.c.

{
  // The Dispatcher may be called on any Window in the Dialog
  struct MuttWindow *dlg = dialog_find(win);
  if (!dlg || !dlg->wdata)
    return FR_ERROR;
 
  struct Menu *menu = dlg->wdata;
  struct PostponeData *pd = menu->mdata;
 
  int rc = FR_UNKNOWN;
  for (size_t i = 0; PostponeFunctions[i].op != OP_NULL; i++)
  {
    const struct PostponeFunction *fn = &PostponeFunctions[i];
    if (fn->op == op)
    {
      rc = fn->function(pd, op);
      break;
    }
  }
 
  if (rc == FR_UNKNOWN) // Not our function
    return rc;
 
  const char *result = dispatcher_get_retval_name(rc);
  mutt_debug(LL_DEBUG1, "Handled %s (%d) -> %s\n", opcodes_get_name(op), op, NONULL(result));
 
  return rc;
}

Here is the call graph for this function:

Here is the caller graph for this function:

sb_function_dispatcher()

int sb_function_dispatcher	(	struct MuttWindow *	win,
		int	op
	)

Perform a Sidebar function - Implements function_dispatcher_t -.

Definition at line 375 of file functions.c.

{
  if (!win || !win->wdata)
    return FR_UNKNOWN;
 
  struct SidebarWindowData *wdata = win->wdata;
  int rc = FR_UNKNOWN;
  for (size_t i = 0; SidebarFunctions[i].op != OP_NULL; i++)
  {
    const struct SidebarFunction *fn = &SidebarFunctions[i];
    if (fn->op == op)
    {
      rc = fn->function(wdata, op);
      break;
    }
  }
 
  if (rc == FR_UNKNOWN) // Not our function
    return rc;
 
  const char *result = dispatcher_get_retval_name(rc);
  mutt_debug(LL_DEBUG1, "Handled %s (%d) -> %s\n", opcodes_get_name(op), op, NONULL(result));
 
  return FR_SUCCESS; // Whatever the outcome, we handled it
}

Here is the call graph for this function:

Here is the caller graph for this function: