functions.c

Go to the documentation of this file.

 
#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"
 
// clang-format off
static const struct MenuFuncOp OpEditor[] = { /* 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 },
};

static const struct MenuOpSeq EditorDefaultBindings[] = { /* 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 },
};
// clang-format on

void editor_init_keys(struct NeoMutt *n, struct SubMenu *sm_generic)
{
  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;
}

void replace_part(struct EnterState *es, size_t from, const char *buf)
{
  /* 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;
}
 
// -----------------------------------------------------------------------------

static int op_editor_complete(struct EnterFunctionData *fdata, const struct KeyEvent *event)
{
  struct EnterWindowData *wdata = fdata->wdata;
  if (wdata->tabs == 0)
  {
    if (wdata->cd)
      completion_data_reset(wdata->cd);
    else
      wdata->cd = completion_data_new();
  }
 
  wdata->tabs++;
  wdata->redraw = ENTER_REDRAW_LINE;
 
  if (wdata->comp_api && wdata->comp_api->complete)
    return wdata->comp_api->complete(wdata, event->op);
 
  return FR_NO_ACTION;
}
 
// -----------------------------------------------------------------------------

static int op_editor_history_down(struct EnterFunctionData *fdata, const struct KeyEvent *event)
{
  struct EnterWindowData *wdata = fdata->wdata;
  if (wdata->hclass == HC_NONE)
    return FR_SUCCESS;
 
  wdata->state->curpos = wdata->state->lastchar;
  if (mutt_hist_at_scratch(wdata->hclass))
  {
    buf_mb_wcstombs(wdata->buffer, wdata->state->wbuf, wdata->state->curpos);
    mutt_hist_save_scratch(wdata->hclass, buf_string(wdata->buffer));
  }
  replace_part(wdata->state, 0, mutt_hist_next(wdata->hclass));
  wdata->redraw = ENTER_REDRAW_INIT;
  return FR_SUCCESS;
}

static int op_editor_history_search(struct EnterFunctionData *fdata,
                                    const struct KeyEvent *event)
{
  struct EnterWindowData *wdata = fdata->wdata;
  if (wdata->hclass == HC_NONE)
    return FR_SUCCESS;
 
  wdata->state->curpos = wdata->state->lastchar;
  buf_mb_wcstombs(wdata->buffer, wdata->state->wbuf, wdata->state->curpos);
  mutt_hist_complete(wdata->buffer, wdata->hclass);
  replace_part(wdata->state, 0, wdata->buffer->data);
  return FR_CONTINUE;
}

static int op_editor_history_up(struct EnterFunctionData *fdata, const struct KeyEvent *event)
{
  struct EnterWindowData *wdata = fdata->wdata;
  if (wdata->hclass == HC_NONE)
    return FR_SUCCESS;
 
  wdata->state->curpos = wdata->state->lastchar;
  if (mutt_hist_at_scratch(wdata->hclass))
  {
    buf_mb_wcstombs(wdata->buffer, wdata->state->wbuf, wdata->state->curpos);
    mutt_hist_save_scratch(wdata->hclass, buf_string(wdata->buffer));
  }
  replace_part(wdata->state, 0, mutt_hist_prev(wdata->hclass));
  wdata->redraw = ENTER_REDRAW_INIT;
  return FR_SUCCESS;
}
 
// -----------------------------------------------------------------------------

static int op_editor_backspace(struct EnterFunctionData *fdata, const struct KeyEvent *event)
{
  struct EnterWindowData *wdata = fdata->wdata;
  int rc = editor_backspace(wdata->state);
 
  if ((rc == FR_ERROR) && editor_buffer_is_empty(wdata->state))
  {
    const bool c_abort_backspace = cs_subset_bool(fdata->n->sub, "abort_backspace");
    if (c_abort_backspace)
    {
      buf_reset(wdata->buffer);
      wdata->done = true;
      rc = FR_SUCCESS;
    }
  }
 
  return rc;
}

static int op_editor_backward_char(struct EnterFunctionData *fdata, const struct KeyEvent *event)
{
  struct EnterWindowData *wdata = fdata->wdata;
  return editor_backward_char(wdata->state);
}

static int op_editor_backward_word(struct EnterFunctionData *fdata, const struct KeyEvent *event)
{
  struct EnterWindowData *wdata = fdata->wdata;
  return editor_backward_word(wdata->state);
}

static int op_editor_bol(struct EnterFunctionData *fdata, const struct KeyEvent *event)
{
  struct EnterWindowData *wdata = fdata->wdata;
  return editor_bol(wdata->state);
}

static int op_editor_capitalize_word(struct EnterFunctionData *fdata,
                                     const struct KeyEvent *event)
{
  struct EnterWindowData *wdata = fdata->wdata;
  enum EnterCase ec;
  switch (event->op)
  {
    case OP_EDITOR_CAPITALIZE_WORD:
      ec = EC_CAPITALIZE;
      break;
    case OP_EDITOR_DOWNCASE_WORD:
      ec = EC_DOWNCASE;
      break;
    case OP_EDITOR_UPCASE_WORD:
      ec = EC_UPCASE;
      break;
    default:
      return FR_ERROR;
  }
  return editor_case_word(wdata->state, ec);
}

static int op_editor_delete_char(struct EnterFunctionData *fdata, const struct KeyEvent *event)
{
  struct EnterWindowData *wdata = fdata->wdata;
  return editor_delete_char(wdata->state);
}

static int op_editor_eol(struct EnterFunctionData *fdata, const struct KeyEvent *event)
{
  struct EnterWindowData *wdata = fdata->wdata;
  int rc = editor_eol(wdata->state);
  wdata->redraw = ENTER_REDRAW_INIT;
  return rc;
}

static int op_editor_forward_char(struct EnterFunctionData *fdata, const struct KeyEvent *event)
{
  struct EnterWindowData *wdata = fdata->wdata;
  return editor_forward_char(wdata->state);
}

static int op_editor_forward_word(struct EnterFunctionData *fdata, const struct KeyEvent *event)
{
  struct EnterWindowData *wdata = fdata->wdata;
  return editor_forward_word(wdata->state);
}

static int op_editor_kill_eol(struct EnterFunctionData *fdata, const struct KeyEvent *event)
{
  struct EnterWindowData *wdata = fdata->wdata;
  return editor_kill_eol(wdata->state);
}

static int op_editor_kill_eow(struct EnterFunctionData *fdata, const struct KeyEvent *event)
{
  struct EnterWindowData *wdata = fdata->wdata;
  return editor_kill_eow(wdata->state);
}

static int op_editor_kill_line(struct EnterFunctionData *fdata, const struct KeyEvent *event)
{
  struct EnterWindowData *wdata = fdata->wdata;
  return editor_kill_line(wdata->state);
}

static int op_editor_kill_whole_line(struct EnterFunctionData *fdata,
                                     const struct KeyEvent *event)
{
  struct EnterWindowData *wdata = fdata->wdata;
  return editor_kill_whole_line(wdata->state);
}

static int op_editor_kill_word(struct EnterFunctionData *fdata, const struct KeyEvent *event)
{
  struct EnterWindowData *wdata = fdata->wdata;
  return editor_kill_word(wdata->state);
}

static int op_editor_quote_char(struct EnterFunctionData *fdata, const struct KeyEvent *event)
{
  struct EnterWindowData *wdata = fdata->wdata;
  struct KeyEvent event_q = { 0, OP_NULL };
  do
  {
    window_redraw(NULL);
    event_q = mutt_getch(GETCH_NONE);
  } while ((event_q.op == OP_TIMEOUT) || (event_q.op == OP_REPAINT));
 
  if (event_q.op != OP_ABORT)
  {
    if (self_insert(wdata, event_q.ch))
    {
      wdata->done = true;
      return FR_SUCCESS;
    }
  }
  return FR_SUCCESS;
}

static int op_editor_transpose_chars(struct EnterFunctionData *fdata,
                                     const struct KeyEvent *event)
{
  struct EnterWindowData *wdata = fdata->wdata;
  return editor_transpose_chars(wdata->state);
}

static int op_help(struct EnterFunctionData *fdata, const struct KeyEvent *event)
{
  mutt_help(fdata->mod_data->md_editor);
  return FR_SUCCESS;
}

static int op_redraw(struct EnterFunctionData *fdata, const struct KeyEvent *event)
{
  mutt_clear_error();
  clearok(stdscr, true);
  mutt_resize_screen();
  window_invalidate_all();
  window_redraw(NULL);
  return FR_SUCCESS;
}
 
// -----------------------------------------------------------------------------

static const struct EnterFunction EnterFunctions[] = {
  // 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
};

int enter_function_dispatcher(struct MuttWindow *win, const struct KeyEvent *event)
{
  if (!event || !win || !win->wdata)
    return FR_UNKNOWN;
 
  const int op = event->op;
 
  struct EditorModuleData *mod_data = neomutt_get_module_data(NeoMutt, MODULE_ID_EDITOR);
 
  struct EnterFunctionData fdata = {
    .n = NeoMutt,
    .mod_data = mod_data,
    .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(&fdata, event);
      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));
 
  dispatcher_flush_on_error(rc);
  return rc;
}

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

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