functions.c File Reference

Editor functions. More...

#include "config.h"
#include <wchar.h>
#include "mutt/lib.h"
#include "config/lib.h"
#include "core/lib.h"
#include "gui/lib.h"
#include "mutt.h"
#include "functions.h"
#include "complete/lib.h"
#include "history/lib.h"
#include "key/lib.h"
#include "menu/lib.h"
#include "enter.h"
#include "module_data.h"
#include "mutt_logging.h"
#include "state.h"
#include "wdata.h"

Include dependency graph for functions.c:

Go to the source code of this file.

Functions
void	editor_init_keys (struct NeoMutt *n, struct SubMenu *sm_generic)
	Initialise the Editor Keybindings - Implements ::init_keys_api.
void	replace_part (struct EnterState *es, size_t from, const char *buf)
	Search and replace on a buffer.
static int	op_editor_complete (struct EnterFunctionData *fdata, const struct KeyEvent *event)
	Complete filename or alias - Implements enter_function_t -.
static int	op_editor_history_down (struct EnterFunctionData *fdata, const struct KeyEvent *event)
	Scroll down through the history list - Implements enter_function_t -.
static int	op_editor_history_search (struct EnterFunctionData *fdata, const struct KeyEvent *event)
	Search through the history list - Implements enter_function_t -.
static int	op_editor_history_up (struct EnterFunctionData *fdata, const struct KeyEvent *event)
	Scroll up through the history list - Implements enter_function_t -.
static int	op_editor_backspace (struct EnterFunctionData *fdata, const struct KeyEvent *event)
	Delete the char in front of the cursor - Implements enter_function_t -.
static int	op_editor_backward_char (struct EnterFunctionData *fdata, const struct KeyEvent *event)
	Move the cursor one character to the left - Implements enter_function_t -.
static int	op_editor_backward_word (struct EnterFunctionData *fdata, const struct KeyEvent *event)
	Move the cursor to the beginning of the word - Implements enter_function_t -.
static int	op_editor_bol (struct EnterFunctionData *fdata, const struct KeyEvent *event)
	Jump to the beginning of the line - Implements enter_function_t -.
static int	op_editor_capitalize_word (struct EnterFunctionData *fdata, const struct KeyEvent *event)
	Capitalize the word - Implements enter_function_t - This function handles:
static int	op_editor_delete_char (struct EnterFunctionData *fdata, const struct KeyEvent *event)
	Delete the char under the cursor - Implements enter_function_t -.
static int	op_editor_eol (struct EnterFunctionData *fdata, const struct KeyEvent *event)
	Jump to the end of the line - Implements enter_function_t -.
static int	op_editor_forward_char (struct EnterFunctionData *fdata, const struct KeyEvent *event)
	Move the cursor one character to the right - Implements enter_function_t -.
static int	op_editor_forward_word (struct EnterFunctionData *fdata, const struct KeyEvent *event)
	Move the cursor to the end of the word - Implements enter_function_t -.
static int	op_editor_kill_eol (struct EnterFunctionData *fdata, const struct KeyEvent *event)
	Delete chars from cursor to end of line - Implements enter_function_t -.
static int	op_editor_kill_eow (struct EnterFunctionData *fdata, const struct KeyEvent *event)
	Delete chars from the cursor to the end of the word - Implements enter_function_t -.
static int	op_editor_kill_line (struct EnterFunctionData *fdata, const struct KeyEvent *event)
	Delete all chars on the line - Implements enter_function_t -.
static int	op_editor_kill_whole_line (struct EnterFunctionData *fdata, const struct KeyEvent *event)
	Delete all chars on the line - Implements enter_function_t -.
static int	op_editor_kill_word (struct EnterFunctionData *fdata, const struct KeyEvent *event)
	Delete the word in front of the cursor - Implements enter_function_t -.
static int	op_editor_quote_char (struct EnterFunctionData *fdata, const struct KeyEvent *event)
	Quote the next typed key - Implements enter_function_t -.
static int	op_editor_transpose_chars (struct EnterFunctionData *fdata, const struct KeyEvent *event)
	Transpose character under cursor with previous - Implements enter_function_t -.
static int	op_help (struct EnterFunctionData *fdata, const struct KeyEvent *event)
	Display Help - Implements enter_function_t -.
static int	op_redraw (struct EnterFunctionData *fdata, const struct KeyEvent *event)
	Redraw the screen - Implements enter_function_t -.
int	enter_function_dispatcher (struct MuttWindow *win, const struct KeyEvent *event)
	Perform an Enter function - Implements function_dispatcher_t -.
struct MenuDefinition *	editor_get_menu_definition (void)
	Get the Editor Menu Definition.
struct SubMenu *	editor_get_submenu (void)
	Get the Editor SubMenu.

Variables
static const struct MenuFuncOp	OpEditor []
	Functions for the Editor Menu.
static const struct MenuOpSeq	EditorDefaultBindings []
	Key bindings for the Editor Menu.
static const struct EnterFunction	EnterFunctions []
	All the NeoMutt functions that Enter supports.

Detailed Description

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

Function Documentation

editor_init_keys()

void editor_init_keys	(	struct NeoMutt *	n,
		struct SubMenu *	sm_generic )

Initialise the Editor Keybindings - Implements ::init_keys_api.

Definition at line 127 of file functions.c.

{
  struct EditorModuleData *mod_data = neomutt_get_module_data(n, MODULE_ID_EDITOR);
  ASSERT(mod_data);
 
  struct MenuDefinition *md = NULL;
  struct SubMenu *sm = NULL;
 
  sm = km_register_submenu(OpEditor);
  md = km_register_menu(MENU_EDITOR, "editor");
  km_menu_add_submenu(md, sm);
  km_menu_add_bindings(md, EditorDefaultBindings);
 
  mod_data->md_editor = md;
  mod_data->sm_editor = sm;
}

Here is the call graph for this function:

Here is the caller graph for this function:

replace_part()

void replace_part	(	struct EnterState *	es,
		size_t	from,
		const char *	buf )

Search and replace on a buffer.

Parameters

es	Current state of the input buffer
from	Starting point for the replacement
buf	Replacement string

Definition at line 150 of file functions.c.

{
  /* Save the suffix */
  size_t savelen = es->lastchar - es->curpos;
  wchar_t *savebuf = NULL;
 
  if (savelen)
  {
    savebuf = MUTT_MEM_CALLOC(savelen, wchar_t);
    wmemcpy(savebuf, es->wbuf + es->curpos, savelen);
  }
 
  /* Convert to wide characters */
  es->curpos = mutt_mb_mbstowcs(&es->wbuf, &es->wbuflen, from, buf);
 
  if (savelen)
  {
    /* Make space for suffix */
    if (es->curpos + savelen > es->wbuflen)
    {
      es->wbuflen = es->curpos + savelen;
      MUTT_MEM_REALLOC(&es->wbuf, es->wbuflen, wchar_t);
    }
 
    /* Restore suffix */
    wmemcpy(es->wbuf + es->curpos, savebuf, savelen);
    FREE(&savebuf);
  }
 
  es->lastchar = es->curpos + savelen;
}

Here is the call graph for this function:

Here is the caller graph for this function:

editor_get_menu_definition()

struct MenuDefinition * editor_get_menu_definition

(

void

)

Get the Editor Menu Definition.

Return values

ptr	Editor Menu Definition

Definition at line 575 of file functions.c.

{
  struct EditorModuleData *mod_data = neomutt_get_module_data(NeoMutt, MODULE_ID_EDITOR);
  ASSERT(mod_data);
 
  return mod_data->md_editor;
}

Here is the call graph for this function:

editor_get_submenu()

struct SubMenu * editor_get_submenu

(

void

)

Get the Editor SubMenu.

Return values

ptr	Editor SubMenu

Definition at line 587 of file functions.c.

{
  struct EditorModuleData *mod_data = neomutt_get_module_data(NeoMutt, MODULE_ID_EDITOR);
  ASSERT(mod_data);
 
  return mod_data->sm_editor;
}

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

OpEditor

const struct MenuFuncOp OpEditor[]

static

Functions for the Editor Menu.

Definition at line 51 of file functions.c.

                                            { /* map: editor */
  { "backspace",                     OP_EDITOR_BACKSPACE },
  { "backward-char",                 OP_EDITOR_BACKWARD_CHAR },
  { "backward-word",                 OP_EDITOR_BACKWARD_WORD },
  { "bol",                           OP_EDITOR_BOL },
  { "capitalize-word",               OP_EDITOR_CAPITALIZE_WORD },
  { "complete",                      OP_EDITOR_COMPLETE },
  { "complete-query",                OP_EDITOR_COMPLETE_QUERY },
  { "delete-char",                   OP_EDITOR_DELETE_CHAR },
  { "downcase-word",                 OP_EDITOR_DOWNCASE_WORD },
  { "eol",                           OP_EDITOR_EOL },
  { "forward-char",                  OP_EDITOR_FORWARD_CHAR },
  { "forward-word",                  OP_EDITOR_FORWARD_WORD },
  { "help",                          OP_HELP },
  { "history-down",                  OP_EDITOR_HISTORY_DOWN },
  { "history-search",                OP_EDITOR_HISTORY_SEARCH },
  { "history-up",                    OP_EDITOR_HISTORY_UP },
  { "kill-eol",                      OP_EDITOR_KILL_EOL },
  { "kill-eow",                      OP_EDITOR_KILL_EOW },
  { "kill-line",                     OP_EDITOR_KILL_LINE },
  { "kill-whole-line",               OP_EDITOR_KILL_WHOLE_LINE },
  { "kill-word",                     OP_EDITOR_KILL_WORD },
  { "mailbox-cycle",                 OP_EDITOR_MAILBOX_CYCLE },
  { "quote-char",                    OP_EDITOR_QUOTE_CHAR },
  { "redraw-screen",                 OP_REDRAW },
  { "transpose-chars",               OP_EDITOR_TRANSPOSE_CHARS },
  { "upcase-word",                   OP_EDITOR_UPCASE_WORD },
  // Deprecated
  { "buffy-cycle",                   OP_EDITOR_MAILBOX_CYCLE, MFF_DEPRECATED },
  { NULL, 0 },
};

EditorDefaultBindings

const struct MenuOpSeq EditorDefaultBindings[]

static

Key bindings for the Editor Menu.

Definition at line 86 of file functions.c.

                                                        { /* map: editor */
  { OP_EDITOR_BACKSPACE,                   "<backspace>" },
  { OP_EDITOR_BACKSPACE,                   "\010" },           // <Ctrl-H>
  { OP_EDITOR_BACKSPACE,                   "\177" },           // <Backspace>
  { OP_EDITOR_BACKWARD_CHAR,               "<left>" },
  { OP_EDITOR_BACKWARD_CHAR,               "\002" },           // <Ctrl-B>
  { OP_EDITOR_BACKWARD_WORD,               "\033b" },          // <Alt-b>
  { OP_EDITOR_BOL,                         "<home>" },
  { OP_EDITOR_BOL,                         "\001" },           // <Ctrl-A>
  { OP_EDITOR_CAPITALIZE_WORD,             "\033c" },          // <Alt-c>
  { OP_EDITOR_COMPLETE,                    "\t" },             // <Tab>
  { OP_EDITOR_COMPLETE_QUERY,              "\024" },           // <Ctrl-T>
  { OP_EDITOR_DELETE_CHAR,                 "<delete>" },
  { OP_EDITOR_DELETE_CHAR,                 "\004" },           // <Ctrl-D>
  { OP_EDITOR_DOWNCASE_WORD,               "\033l" },          // <Alt-l>
  { OP_EDITOR_EOL,                         "<end>" },
  { OP_EDITOR_EOL,                         "\005" },           // <Ctrl-E>
  { OP_EDITOR_FORWARD_CHAR,                "<right>" },
  { OP_EDITOR_FORWARD_CHAR,                "\006" },           // <Ctrl-F>
  { OP_EDITOR_FORWARD_WORD,                "\033f" },          // <Alt-f>
  { OP_EDITOR_HISTORY_DOWN,                "<down>" },
  { OP_EDITOR_HISTORY_DOWN,                "\016" },           // <Ctrl-N>
  { OP_EDITOR_HISTORY_SEARCH,              "\022" },           // <Ctrl-R>
  { OP_EDITOR_HISTORY_UP,                  "<up>" },
  { OP_EDITOR_HISTORY_UP,                  "\020" },           // <Ctrl-P>
  { OP_EDITOR_KILL_EOL,                    "\013" },           // <Ctrl-K>
  { OP_EDITOR_KILL_EOW,                    "\033d" },          // <Alt-d>
  { OP_EDITOR_KILL_LINE,                   "\025" },           // <Ctrl-U>
  { OP_EDITOR_KILL_WORD,                   "\027" },           // <Ctrl-W>
  { OP_EDITOR_MAILBOX_CYCLE,               " " },              // <Space>
  { OP_EDITOR_QUOTE_CHAR,                  "\026" },           // <Ctrl-V>
  { OP_EDITOR_UPCASE_WORD,                 "\033u" },          // <Alt-u>
  { OP_HELP,                               "\033?" },          // <Alt-?>
  { OP_REDRAW,                             "\014" },           // <Ctrl-L>
  { 0, NULL },
};

EnterFunctions

const struct EnterFunction EnterFunctions[]

static

All the NeoMutt functions that Enter supports.

Definition at line 500 of file functions.c.

                                                     {
  // clang-format off
  { OP_EDITOR_BACKSPACE,          op_editor_backspace },
  { OP_EDITOR_BACKWARD_CHAR,      op_editor_backward_char },
  { OP_EDITOR_BACKWARD_WORD,      op_editor_backward_word },
  { OP_EDITOR_BOL,                op_editor_bol },
  { OP_EDITOR_CAPITALIZE_WORD,    op_editor_capitalize_word },
  { OP_EDITOR_COMPLETE,           op_editor_complete },
  { OP_EDITOR_COMPLETE_QUERY,     op_editor_complete },
  { OP_EDITOR_DELETE_CHAR,        op_editor_delete_char },
  { OP_EDITOR_DOWNCASE_WORD,      op_editor_capitalize_word },
  { OP_EDITOR_EOL,                op_editor_eol },
  { OP_EDITOR_FORWARD_CHAR,       op_editor_forward_char },
  { OP_EDITOR_FORWARD_WORD,       op_editor_forward_word },
  { OP_EDITOR_HISTORY_DOWN,       op_editor_history_down },
  { OP_EDITOR_HISTORY_SEARCH,     op_editor_history_search },
  { OP_EDITOR_HISTORY_UP,         op_editor_history_up },
  { OP_EDITOR_KILL_EOL,           op_editor_kill_eol },
  { OP_EDITOR_KILL_EOW,           op_editor_kill_eow },
  { OP_EDITOR_KILL_LINE,          op_editor_kill_line },
  { OP_EDITOR_KILL_WHOLE_LINE,    op_editor_kill_whole_line },
  { OP_EDITOR_KILL_WORD,          op_editor_kill_word },
  { OP_EDITOR_MAILBOX_CYCLE,      op_editor_complete },
  { OP_EDITOR_QUOTE_CHAR,         op_editor_quote_char },
  { OP_EDITOR_TRANSPOSE_CHARS,    op_editor_transpose_chars },
  { OP_EDITOR_UPCASE_WORD,        op_editor_capitalize_word },
  { OP_HELP,                      op_help },
  { OP_REDRAW,                    op_redraw },
  { 0, NULL },
  // clang-format on
};