tagging.c File Reference

Tagging support. More...

#include "config.h"
#include <stdbool.h>
#include <stddef.h>
#include "mutt/lib.h"
#include "config/lib.h"
#include "core/lib.h"
#include "gui/lib.h"
#include "lib.h"
#include "color/lib.h"
#include "key/lib.h"

Include dependency graph for tagging.c:

Go to the source code of this file.

Functions
static void	menu_set_prefix (struct Menu *menu)
	Set tag_prefix on $auto_tag.
static int	op_end_cond (struct Menu *menu, int op)
	End of conditional execution (noop)
static int	op_tag (struct Menu *menu, int op)
	Tag the current entry.
static int	op_tag_prefix (struct Menu *menu, int op)
	Apply next function to tagged messages.
static int	op_tag_prefix_cond (struct Menu *menu, int op)
	Apply next function ONLY to tagged messages.
static int	menu_abort (struct Menu *menu)
	User aborted an operation.
static int	menu_timeout (struct Menu *menu)
	Timeout waiting for a keypress.
static int	menu_other (struct Menu *menu)
	Some non-tagging operation occurred.
int	menu_tagging_dispatcher (struct MuttWindow *win, int op)
	Perform tagging operations on the Menu - Implements function_dispatcher_t -.

Detailed Description

Tagging support.

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 tagging.c.

Function Documentation

menu_set_prefix()

static void menu_set_prefix ( struct Menu * menu )

static

Set tag_prefix on $auto_tag.

Parameters

menu

Menu

Definition at line 44 of file tagging.c.

{
  const bool c_auto_tag = cs_subset_bool(menu->sub, "auto_tag");
  if ((menu->num_tagged != 0) && c_auto_tag)
    menu->tag_prefix = true;
 
  mutt_debug(LL_DEBUG1, "tag_prefix = %d\n", menu->tag_prefix);
 
  // Don't overwrite error messages
  const char *msg_text = msgwin_get_text(NULL);
  if (msg_text && (msg_text[0] != '\0') && !mutt_str_equal(msg_text, "tag-"))
    return;
 
  if (menu->tag_prefix)
  {
    msgwin_set_text(NULL, "tag-", MT_COLOR_NORMAL);
  }
  else
  {
    msgwin_clear_text(NULL);
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

op_end_cond()

static int op_end_cond ( struct Menu * menu, int op )

static

End of conditional execution (noop)

Parameters

menu	Menu
op	Operation to perform, e.g. OP_END_COND

Return values

enum	FunctionRetval

Definition at line 73 of file tagging.c.

{
  menu->tag_prefix = false;
  menu_set_prefix(menu);
  return FR_SUCCESS;
}

Here is the call graph for this function:

Here is the caller graph for this function:

op_tag()

static int op_tag ( struct Menu * menu, int op )

static

Tag the current entry.

Parameters

menu	Menu
op	Operation to perform, e.g. OP_TAG

Return values

enum	FunctionRetval

Definition at line 86 of file tagging.c.

{
  const bool c_auto_tag = cs_subset_bool(menu->sub, "auto_tag");
  int rc = FR_SUCCESS;
 
  if ((menu->num_tagged != 0) && c_auto_tag)
    menu->tag_prefix = true;
 
  if (!menu->tag)
  {
    mutt_error(_("Tagging is not supported"));
    return FR_ERROR;
  }
 
  if (menu->tag_prefix && !c_auto_tag)
  {
    for (int i = 0; i < menu->max; i++)
      menu->num_tagged += menu->tag(menu, i, 0);
 
    menu->redraw |= MENU_REDRAW_INDEX;
  }
  else if (menu->max != 0)
  {
    int num = menu->tag(menu, menu->current, -1);
    menu->num_tagged += num;
 
    const bool c_resolve = cs_subset_bool(menu->sub, "resolve");
    if ((num != 0) && c_resolve && (menu->current < (menu->max - 1)))
    {
      menu_set_index(menu, menu->current + 1);
    }
    else
    {
      menu->redraw |= MENU_REDRAW_CURRENT;
    }
  }
  else
  {
    mutt_error(_("No entries"));
    rc = FR_ERROR;
  }
 
  menu->tag_prefix = ((menu->num_tagged != 0) && c_auto_tag);
 
  /* give visual indication that the next command is a tag- command */
  if (menu->tag_prefix)
  {
    msgwin_set_text(NULL, "tag-", MT_COLOR_NORMAL);
  }
 
  menu->win->actions |= WA_REPAINT;
  return rc;
}

Here is the call graph for this function:

Here is the caller graph for this function:

op_tag_prefix()

static int op_tag_prefix ( struct Menu * menu, int op )

static

Apply next function to tagged messages.

Parameters

menu	Menu
op	Operation to perform, e.g. OP_TAG_PREFIX

Return values

enum	FunctionRetval

Definition at line 146 of file tagging.c.

{
  if (menu->tag_prefix)
  {
    menu->tag_prefix = false;
    menu_set_prefix(menu);
  }
  else if (menu->num_tagged == 0)
  {
    mutt_warning(_("No tagged entries"));
  }
  else
  {
    menu->tag_prefix = true;
    menu_set_prefix(menu);
  }
 
  return FR_SUCCESS;
}

Here is the call graph for this function:

Here is the caller graph for this function:

op_tag_prefix_cond()

static int op_tag_prefix_cond ( struct Menu * menu, int op )

static

Apply next function ONLY to tagged messages.

Parameters

menu	Menu
op	Operation to perform, e.g. OP_TAG_PREFIX_COND

Return values

enum	FunctionRetval

Definition at line 172 of file tagging.c.

{
  if (menu->tag_prefix)
  {
    menu->tag_prefix = false;
  }
  else if (menu->num_tagged == 0)
  {
    mutt_flush_macro_to_endcond();
    mutt_debug(LL_DEBUG1, "nothing to do\n");
  }
  else
  {
    menu->tag_prefix = true;
  }
 
  menu_set_prefix(menu);
  return FR_SUCCESS;
}

Here is the call graph for this function:

Here is the caller graph for this function:

menu_abort()

static int menu_abort ( struct Menu * menu )

static

User aborted an operation.

Parameters

menu

Menu

Return values

enum	FunctionRetval

Definition at line 197 of file tagging.c.

{
  menu->tag_prefix = false;
  menu_set_prefix(menu);
  return FR_SUCCESS;
}

Here is the call graph for this function:

Here is the caller graph for this function:

menu_timeout()

static int menu_timeout ( struct Menu * menu )

static

Timeout waiting for a keypress.

Parameters

menu

Menu

Return values

enum	FunctionRetval

Definition at line 209 of file tagging.c.

{
  menu_set_prefix(menu);
  return FR_SUCCESS;
}

Here is the call graph for this function:

Here is the caller graph for this function:

menu_other()

static int menu_other ( struct Menu * menu )

static

Some non-tagging operation occurred.

Parameters

menu

Menu

Return values

enum	FunctionRetval

Definition at line 220 of file tagging.c.

{
  menu->tag_prefix = false;
  menu_set_prefix(menu);
  return FR_SUCCESS;
}

Here is the call graph for this function:

Here is the caller graph for this function: