functions.c File Reference

Enter functions. More...

#include "config.h"
#include <string.h>
#include <wchar.h>
#include "mutt/lib.h"
#include "config/helpers.h"
#include "core/lib.h"
#include "alias/lib.h"
#include "gui/lib.h"
#include "mutt.h"
#include "functions.h"
#include "browser/lib.h"
#include "complete/lib.h"
#include "history/lib.h"
#include "pattern/lib.h"
#include "enter.h"
#include "keymap.h"
#include "mutt_history.h"
#include "mutt_mailbox.h"
#include "muttlib.h"
#include "opcodes.h"
#include "state.h"
#include "wdata.h"

Include dependency graph for functions.c:

Go to the source code of this file.

Functions
static void	replace_part (struct EnterState *es, size_t from, const char *buf)
	Search and replace on a buffer. More...
static int	complete_file_simple (struct EnterWindowData *wdata)
	Complete a filename. More...
static int	complete_alias_complete (struct EnterWindowData *wdata)
	Complete an Alias. More...
static int	complete_label (struct EnterWindowData *wdata)
	Complete a label. More...
static int	complete_pattern (struct EnterWindowData *wdata)
	Complete a NeoMutt Pattern. More...
static int	complete_alias_query (struct EnterWindowData *wdata)
	Complete an Alias Query. More...
static int	complete_command (struct EnterWindowData *wdata)
	Complete a NeoMutt Command. More...
static int	complete_file_mbox (struct EnterWindowData *wdata)
	Complete a Mailbox. More...
static int	complete_nm_query (struct EnterWindowData *wdata)
	Complete a Notmuch Query. More...
static int	complete_nm_tag (struct EnterWindowData *wdata)
	Complete a Notmuch Tag. More...
static int	op_editor_complete (struct EnterWindowData *wdata, int op)
	Complete filename or alias - Implements enter_function_t -. More...
static int	op_editor_history_down (struct EnterWindowData *wdata, int op)
	Scroll down through the history list - Implements enter_function_t -. More...
static int	op_editor_history_search (struct EnterWindowData *wdata, int op)
	Search through the history list - Implements enter_function_t -. More...
static int	op_editor_history_up (struct EnterWindowData *wdata, int op)
	Scroll up through the history list - Implements enter_function_t -. More...
static int	op_editor_mailbox_cycle (struct EnterWindowData *wdata, int op)
	Cycle among incoming mailboxes - Implements enter_function_t -. More...
static int	op_editor_backspace (struct EnterWindowData *wdata, int op)
	Delete the char in front of the cursor - Implements enter_function_t -. More...
static int	op_editor_backward_char (struct EnterWindowData *wdata, int op)
	Move the cursor one character to the left - Implements enter_function_t -. More...
static int	op_editor_backward_word (struct EnterWindowData *wdata, int op)
	Move the cursor to the beginning of the word - Implements enter_function_t -. More...
static int	op_editor_bol (struct EnterWindowData *wdata, int op)
	Jump to the beginning of the line - Implements enter_function_t -. More...
static int	op_editor_capitalize_word (struct EnterWindowData *wdata, int op)
	Capitalize the word - Implements enter_function_t - This function handles: More...
static int	op_editor_delete_char (struct EnterWindowData *wdata, int op)
	Delete the char under the cursor - Implements enter_function_t -. More...
static int	op_editor_eol (struct EnterWindowData *wdata, int op)
	Jump to the end of the line - Implements enter_function_t -. More...
static int	op_editor_forward_char (struct EnterWindowData *wdata, int op)
	Move the cursor one character to the right - Implements enter_function_t -. More...
static int	op_editor_forward_word (struct EnterWindowData *wdata, int op)
	Move the cursor to the end of the word - Implements enter_function_t -. More...
static int	op_editor_kill_eol (struct EnterWindowData *wdata, int op)
	Delete chars from cursor to end of line - Implements enter_function_t -. More...
static int	op_editor_kill_eow (struct EnterWindowData *wdata, int op)
	Delete chars from the cursor to the end of the word - Implements enter_function_t -. More...
static int	op_editor_kill_line (struct EnterWindowData *wdata, int op)
	Delete all chars on the line - Implements enter_function_t -. More...
static int	op_editor_kill_whole_line (struct EnterWindowData *wdata, int op)
	Delete all chars on the line - Implements enter_function_t -. More...
static int	op_editor_kill_word (struct EnterWindowData *wdata, int op)
	Delete the word in front of the cursor - Implements enter_function_t -. More...
static int	op_editor_quote_char (struct EnterWindowData *wdata, int op)
	Quote the next typed key - Implements enter_function_t -. More...
static int	op_editor_transpose_chars (struct EnterWindowData *wdata, int op)
	Transpose character under cursor with previous - Implements enter_function_t -. More...
int	enter_function_dispatcher (struct MuttWindow *win, int op)
	Perform an Enter function - Implements function_dispatcher_t -. More...

Variables
static const struct EnterFunction	EnterFunctions []
	All the NeoMutt functions that Enter supports. More...

Detailed Description

Enter 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

replace_part()

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

static

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 58 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, sizeof(wchar_t));
    memcpy(savebuf, es->wbuf + es->curpos, savelen * sizeof(wchar_t));
  }
 
  /* 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 * sizeof(wchar_t));
    }
 
    /* Restore suffix */
    memcpy(es->wbuf + es->curpos, savebuf, savelen * sizeof(wchar_t));
    FREE(&savebuf);
  }
 
  es->lastchar = es->curpos + savelen;
}

Here is the call graph for this function:

Here is the caller graph for this function:

complete_file_simple()

static int complete_file_simple ( struct EnterWindowData *  wdata )

static

Complete a filename.

Parameters

wdata

Enter window data

Return values

num	FunctionRetval, e.g. FR_SUCCESS

Definition at line 97 of file functions.c.

{
  int rc = FR_SUCCESS;
  size_t i;
  for (i = wdata->state->curpos;
       (i > 0) && !mutt_mb_is_shell_char(wdata->state->wbuf[i - 1]); i--)
  {
  }
  mutt_mb_wcstombs(wdata->buf, wdata->buflen, wdata->state->wbuf + i,
                   wdata->state->curpos - i);
  if (wdata->tempbuf && (wdata->templen == (wdata->state->lastchar - i)) &&
      (memcmp(wdata->tempbuf, wdata->state->wbuf + i,
              (wdata->state->lastchar - i) * sizeof(wchar_t)) == 0))
  {
    mutt_select_file(wdata->buf, wdata->buflen, MUTT_SEL_NO_FLAGS, wdata->m, NULL, NULL);
    if (wdata->buf[0] != '\0')
      replace_part(wdata->state, i, wdata->buf);
    return FR_CONTINUE;
  }
 
  if (mutt_complete(wdata->cd, wdata->buf, wdata->buflen) == 0)
  {
    wdata->templen = wdata->state->lastchar - i;
    mutt_mem_realloc(&wdata->tempbuf, wdata->templen * sizeof(wchar_t));
    memcpy(wdata->tempbuf, wdata->state->wbuf + i, wdata->templen * sizeof(wchar_t));
  }
  else
  {
    rc = FR_ERROR;
  }
 
  replace_part(wdata->state, i, wdata->buf);
  return rc;
}

Here is the call graph for this function:

Here is the caller graph for this function:

complete_alias_complete()

static int complete_alias_complete ( struct EnterWindowData *  wdata )

static

Complete an Alias.

Parameters

wdata

Enter window data

Return values

num	FunctionRetval, e.g. FR_SUCCESS

Definition at line 137 of file functions.c.

{
  /* invoke the alias-menu to get more addresses */
  size_t i;
  for (i = wdata->state->curpos; (i > 0) && (wdata->state->wbuf[i - 1] != ',') &&
                                 (wdata->state->wbuf[i - 1] != ':');
       i--)
  {
  }
  for (; (i < wdata->state->lastchar) && (wdata->state->wbuf[i] == ' '); i++)
    ; // do nothing
 
  mutt_mb_wcstombs(wdata->buf, wdata->buflen, wdata->state->wbuf + i,
                   wdata->state->curpos - i);
  int rc = alias_complete(wdata->buf, wdata->buflen, NeoMutt->sub);
  replace_part(wdata->state, i, wdata->buf);
  if (rc != 1)
  {
    return FR_CONTINUE;
  }
 
  return FR_SUCCESS;
}

Here is the call graph for this function:

Here is the caller graph for this function:

complete_label()

static int complete_label ( struct EnterWindowData *  wdata )

static

Complete a label.

Parameters

wdata

Enter window data

Return values

num	FunctionRetval, e.g. FR_SUCCESS

Definition at line 166 of file functions.c.

{
  size_t i;
  for (i = wdata->state->curpos; (i > 0) && (wdata->state->wbuf[i - 1] != ',') &&
                                 (wdata->state->wbuf[i - 1] != ':');
       i--)
  {
  }
  for (; (i < wdata->state->lastchar) && (wdata->state->wbuf[i] == ' '); i++)
    ; // do nothing
 
  mutt_mb_wcstombs(wdata->buf, wdata->buflen, wdata->state->wbuf + i,
                   wdata->state->curpos - i);
  int rc = mutt_label_complete(wdata->cd, wdata->buf, wdata->buflen, wdata->tabs);
  replace_part(wdata->state, i, wdata->buf);
  if (rc != 1)
    return FR_CONTINUE;
 
  return FR_SUCCESS;
}

Here is the call graph for this function:

Here is the caller graph for this function:

complete_pattern()

static int complete_pattern ( struct EnterWindowData *  wdata )

static

Complete a NeoMutt Pattern.

Parameters

wdata

Enter window data

Return values

num	FunctionRetval, e.g. FR_SUCCESS

Definition at line 192 of file functions.c.

{
  size_t i = wdata->state->curpos;
  if (i && (wdata->state->wbuf[i - 1] == '~'))
  {
    if (dlg_select_pattern(wdata->buf, wdata->buflen))
      replace_part(wdata->state, i - 1, wdata->buf);
    return FR_CONTINUE;
  }
 
  for (; (i > 0) && (wdata->state->wbuf[i - 1] != '~'); i--)
    ; // do nothing
 
  if ((i > 0) && (i < wdata->state->curpos) &&
      (wdata->state->wbuf[i - 1] == '~') && (wdata->state->wbuf[i] == 'y'))
  {
    i++;
    mutt_mb_wcstombs(wdata->buf, wdata->buflen, wdata->state->wbuf + i,
                     wdata->state->curpos - i);
    int rc = mutt_label_complete(wdata->cd, wdata->buf, wdata->buflen, wdata->tabs);
    replace_part(wdata->state, i, wdata->buf);
    if (rc != 1)
    {
      return FR_CONTINUE;
    }
  }
  else
  {
    return FR_NO_ACTION;
  }
 
  return FR_SUCCESS;
}

Here is the call graph for this function:

Here is the caller graph for this function:

complete_alias_query()

static int complete_alias_query ( struct EnterWindowData *  wdata )

static

Complete an Alias Query.

Parameters

wdata

Enter window data

Return values

num	FunctionRetval, e.g. FR_SUCCESS

Definition at line 231 of file functions.c.

{
  size_t i = wdata->state->curpos;
  if (i != 0)
  {
    for (; (i > 0) && (wdata->state->wbuf[i - 1] != ','); i--)
      ; // do nothing
 
    for (; (i < wdata->state->curpos) && (wdata->state->wbuf[i] == ' '); i++)
      ; // do nothing
  }
 
  mutt_mb_wcstombs(wdata->buf, wdata->buflen, wdata->state->wbuf + i,
                   wdata->state->curpos - i);
  struct Buffer *tmp = buf_pool_get();
  buf_strcpy(tmp, wdata->buf);
  query_complete(tmp, NeoMutt->sub);
  mutt_str_copy(wdata->buf, buf_string(tmp), wdata->buflen);
  buf_pool_release(&tmp);
  replace_part(wdata->state, i, wdata->buf);
 
  return FR_CONTINUE;
}

Here is the call graph for this function:

Here is the caller graph for this function:

complete_command()

static int complete_command ( struct EnterWindowData *  wdata )

static

Complete a NeoMutt Command.

Parameters

wdata

Enter window data

Return values

num	FunctionRetval, e.g. FR_SUCCESS

Definition at line 260 of file functions.c.

{
  int rc = FR_SUCCESS;
  mutt_mb_wcstombs(wdata->buf, wdata->buflen, wdata->state->wbuf, wdata->state->curpos);
  size_t i = strlen(wdata->buf);
  if ((i != 0) && (wdata->buf[i - 1] == '=') &&
      (mutt_var_value_complete(wdata->cd, wdata->buf, wdata->buflen, i) != 0))
  {
    wdata->tabs = 0;
  }
  else if (mutt_command_complete(wdata->cd, wdata->buf, wdata->buflen, i, wdata->tabs) == 0)
  {
    rc = FR_ERROR;
  }
 
  replace_part(wdata->state, 0, wdata->buf);
  return rc;
}

Here is the call graph for this function:

Here is the caller graph for this function:

complete_file_mbox()

static int complete_file_mbox ( struct EnterWindowData *  wdata )

static

Complete a Mailbox.

Parameters

wdata

Enter window data

Return values

num	FunctionRetval, e.g. FR_SUCCESS

Definition at line 284 of file functions.c.

{
  int rc = FR_SUCCESS;
  mutt_mb_wcstombs(wdata->buf, wdata->buflen, wdata->state->wbuf, wdata->state->curpos);
 
  /* see if the path has changed from the last time */
  if ((!wdata->tempbuf && !wdata->state->lastchar) ||
      (wdata->tempbuf && (wdata->templen == wdata->state->lastchar) &&
       (memcmp(wdata->tempbuf, wdata->state->wbuf,
               wdata->state->lastchar * sizeof(wchar_t)) == 0)))
  {
    mutt_select_file(wdata->buf, wdata->buflen,
                     ((wdata->flags & MUTT_COMP_FILE_MBOX) ? MUTT_SEL_FOLDER : MUTT_SEL_NO_FLAGS) |
                         (wdata->multiple ? MUTT_SEL_MULTI : MUTT_SEL_NO_FLAGS),
                     wdata->m, wdata->files, wdata->numfiles);
    if (wdata->buf[0] != '\0')
    {
      mutt_pretty_mailbox(wdata->buf, wdata->buflen);
      if (!wdata->pass)
        mutt_hist_add(wdata->hclass, wdata->buf, true);
      wdata->done = true;
      return FR_SUCCESS;
    }
 
    /* file selection cancelled */
    return FR_CONTINUE;
  }
 
  if (mutt_complete(wdata->cd, wdata->buf, wdata->buflen) == 0)
  {
    wdata->templen = wdata->state->lastchar;
    mutt_mem_realloc(&wdata->tempbuf, wdata->templen * sizeof(wchar_t));
    memcpy(wdata->tempbuf, wdata->state->wbuf, wdata->templen * sizeof(wchar_t));
  }
  else
  {
    return FR_ERROR; // let the user know that nothing matched
  }
  replace_part(wdata->state, 0, wdata->buf);
  return rc;
}

Here is the call graph for this function:

Here is the caller graph for this function:

complete_nm_query()

static int complete_nm_query ( struct EnterWindowData *  wdata )

static

Complete a Notmuch Query.

Parameters

wdata

Enter window data

Return values

num	FunctionRetval, e.g. FR_SUCCESS

Definition at line 332 of file functions.c.

{
  int rc = FR_SUCCESS;
  mutt_mb_wcstombs(wdata->buf, wdata->buflen, wdata->state->wbuf, wdata->state->curpos);
  size_t len = strlen(wdata->buf);
  if (!mutt_nm_query_complete(wdata->cd, wdata->buf, wdata->buflen, len, wdata->tabs))
    rc = FR_ERROR;
 
  replace_part(wdata->state, 0, wdata->buf);
  return rc;
}

Here is the call graph for this function:

Here is the caller graph for this function:

complete_nm_tag()

static int complete_nm_tag ( struct EnterWindowData *  wdata )

static

Complete a Notmuch Tag.

Parameters

wdata

Enter window data

Return values

num	FunctionRetval, e.g. FR_SUCCESS

Definition at line 349 of file functions.c.

{
  int rc = FR_SUCCESS;
  mutt_mb_wcstombs(wdata->buf, wdata->buflen, wdata->state->wbuf, wdata->state->curpos);
  if (!mutt_nm_tag_complete(wdata->cd, wdata->buf, wdata->buflen, wdata->tabs))
    rc = FR_ERROR;
 
  replace_part(wdata->state, 0, wdata->buf);
  return rc;
}

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

EnterFunctions

const struct EnterFunction EnterFunctions[]

static

Initial value:

= {
  
  { 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_mailbox_cycle },
  { OP_EDITOR_QUOTE_CHAR,         op_editor_quote_char },
  { OP_EDITOR_TRANSPOSE_CHARS,    op_editor_transpose_chars },
  { OP_EDITOR_UPCASE_WORD,        op_editor_capitalize_word },
  { 0, NULL },
  
}

All the NeoMutt functions that Enter supports.

Definition at line 669 of file functions.c.