functions.c File Reference

Menu functions. More...

#include "config.h"
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
#include "mutt/lib.h"
#include "config/lib.h"
#include "core/lib.h"
#include "gui/lib.h"
#include "mutt.h"
#include "functions.h"
#include "lib.h"
#include "editor/lib.h"
#include "history/lib.h"
#include "key/lib.h"
#include "module_data.h"
#include "type.h"

Include dependency graph for functions.c:

Go to the source code of this file.

Macros
#define	MUTT_SEARCH_UP   1
#define	MUTT_SEARCH_DOWN   2

Functions
static int	search (struct Menu *menu, int op, int *match)
	Search a menu.
static int	menu_movement (struct MenuFunctionData *fdata, const struct KeyEvent *event)
	Handle all the common Menu movements - Implements menu_function_t -.
static int	menu_search (struct MenuFunctionData *fdata, const struct KeyEvent *event)
	Handle Menu searching - Implements menu_function_t -.
static int	op_help (struct MenuFunctionData *fdata, const struct KeyEvent *event)
	Show the help screen - Implements menu_function_t -.
static int	op_jump (struct MenuFunctionData *fdata, const struct KeyEvent *event)
	Jump to an index number - Implements menu_function_t -.
int	menu_function_dispatcher (struct MuttWindow *win, const struct KeyEvent *event)
	Perform a Menu function - Implements function_dispatcher_t -.

Variables
static const struct MenuFunction	MenuFunctions []
	All the NeoMutt functions that the Menu supports.

Detailed Description

Menu functions.

Authors

• Pietro Cerutti
• 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.c.

Macro Definition Documentation

MUTT_SEARCH_UP

#define MUTT_SEARCH_UP   1

Definition at line 47 of file functions.c.

MUTT_SEARCH_DOWN

#define MUTT_SEARCH_DOWN   2

Definition at line 48 of file functions.c.

Function Documentation

search()

static int search ( struct Menu * menu, int op, int * match )

static

Search a menu.

Parameters

	menu	Menu to search
	op	Search operation, e.g. OP_SEARCH_NEXT
[out]	match	Index of matching item, or -1 on failure

Return values

FR_SUCCESS	Match found
FR_NO_ACTION	Search was cancelled
FR_ERROR	Search failed

Definition at line 59 of file functions.c.

{
  struct MenuModuleData *mod_data = neomutt_get_module_data(NeoMutt, MODULE_ID_MENU);
  int reg_rc = 0;
  int wrap = 0;
  int search_dir;
  int rc = FR_ERROR;
  regex_t re = { 0 };
  struct Buffer *buf = buf_pool_get();
 
  *match = -1;
 
  char *search_buf = (menu->md && (menu->md->id < MENU_MAX)) ?
                         mod_data->search_buffers[menu->md->id] :
                         NULL;
 
  if (!(search_buf && *search_buf) || ((op != OP_SEARCH_NEXT) && (op != OP_SEARCH_OPPOSITE)))
  {
    buf_strcpy(buf, search_buf && (search_buf[0] != '\0') ? search_buf : "");
    if ((mw_get_field(((op == OP_SEARCH) || (op == OP_SEARCH_NEXT)) ? _("Search for: ") : _("Reverse search for: "),
                      buf, MUTT_COMP_CLEAR, HC_OTHER, NULL, NULL) != 0) ||
        buf_is_empty(buf))
    {
      rc = FR_NO_ACTION;
      goto done;
    }
    if (menu->md && (menu->md->id < MENU_MAX))
    {
      mutt_str_replace(&mod_data->search_buffers[menu->md->id], buf_string(buf));
      search_buf = mod_data->search_buffers[menu->md->id];
    }
    menu->search_dir = ((op == OP_SEARCH) || (op == OP_SEARCH_NEXT)) ?
                           MUTT_SEARCH_DOWN :
                           MUTT_SEARCH_UP;
  }
 
  search_dir = (menu->search_dir == MUTT_SEARCH_UP) ? -1 : 1;
  if (op == OP_SEARCH_OPPOSITE)
    search_dir = -search_dir;
 
  if (search_buf)
  {
    uint16_t flags = mutt_mb_is_lower(search_buf) ? REG_ICASE : 0;
    reg_rc = REG_COMP(&re, search_buf, REG_NOSUB | flags);
  }
 
  if (reg_rc != 0)
  {
    regerror(reg_rc, &re, buf->data, buf->dsize);
    mutt_error("%s", buf_string(buf));
    goto done;
  }
 
  *match = menu->current + search_dir;
search_next:
  if (wrap)
    mutt_message(_("Search wrapped to top"));
  while ((*match >= 0) && (*match < menu->max))
  {
    if (menu->search(menu, &re, *match) == 0)
    {
      regfree(&re);
      rc = FR_SUCCESS;
      goto done;
    }
 
    *match += search_dir;
  }
 
  const bool c_wrap_search = cs_subset_bool(menu->sub, "wrap_search");
  if (c_wrap_search && (wrap++ == 0))
  {
    *match = (search_dir == 1) ? 0 : menu->max - 1;
    goto search_next;
  }
  regfree(&re);
  mutt_error(_("Not found"));
 
done:
  buf_pool_release(&buf);
  return rc;
}

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

MenuFunctions

const struct MenuFunction MenuFunctions[]

static

Initial value:

= {
  
  { OP_BOTTOM_PAGE,            menu_movement },
  { OP_CURRENT_BOTTOM,         menu_movement },
  { OP_CURRENT_MIDDLE,         menu_movement },
  { OP_CURRENT_TOP,            menu_movement },
  { OP_FIRST_ENTRY,            menu_movement },
  { OP_HALF_DOWN,              menu_movement },
  { OP_HALF_UP,                menu_movement },
  { OP_HELP,                   op_help },
  { OP_JUMP,                   op_jump },
  { OP_LAST_ENTRY,             menu_movement },
  { OP_MIDDLE_PAGE,            menu_movement },
  { OP_NEXT_ENTRY,             menu_movement },
  { OP_NEXT_LINE,              menu_movement },
  { OP_NEXT_PAGE,              menu_movement },
  { OP_PREV_ENTRY,             menu_movement },
  { OP_PREV_LINE,              menu_movement },
  { OP_PREV_PAGE,              menu_movement },
  { OP_SEARCH,                 menu_search },
  { OP_SEARCH_NEXT,            menu_search },
  { OP_SEARCH_OPPOSITE,        menu_search },
  { OP_SEARCH_REVERSE,         menu_search },
  { OP_TOP_PAGE,               menu_movement },
  { 0, NULL },
  
}

All the NeoMutt functions that the Menu supports.

Definition at line 335 of file functions.c.

                                                   {
  // clang-format off
  { OP_BOTTOM_PAGE,            menu_movement },
  { OP_CURRENT_BOTTOM,         menu_movement },
  { OP_CURRENT_MIDDLE,         menu_movement },
  { OP_CURRENT_TOP,            menu_movement },
  { OP_FIRST_ENTRY,            menu_movement },
  { OP_HALF_DOWN,              menu_movement },
  { OP_HALF_UP,                menu_movement },
  { OP_HELP,                   op_help },
  { OP_JUMP,                   op_jump },
  { OP_LAST_ENTRY,             menu_movement },
  { OP_MIDDLE_PAGE,            menu_movement },
  { OP_NEXT_ENTRY,             menu_movement },
  { OP_NEXT_LINE,              menu_movement },
  { OP_NEXT_PAGE,              menu_movement },
  { OP_PREV_ENTRY,             menu_movement },
  { OP_PREV_LINE,              menu_movement },
  { OP_PREV_PAGE,              menu_movement },
  { OP_SEARCH,                 menu_search },
  { OP_SEARCH_NEXT,            menu_search },
  { OP_SEARCH_OPPOSITE,        menu_search },
  { OP_SEARCH_REVERSE,         menu_search },
  { OP_TOP_PAGE,               menu_movement },
  { 0, NULL },
  // clang-format on
};