Enter Function API

Prototype for a Enter Function. More...

Functions
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 -.

Detailed Description

Prototype for a Enter Function.

Parameters

fdata	Enter Function context data
event	Event to process

Return values

enum	FunctionRetval

Precondition

fdata is not NULL

event is not NULL

Function Documentation

op_editor_complete()

static int op_editor_complete ( struct EnterFunctionData * fdata, const struct KeyEvent * event )

static

Complete filename or alias - Implements enter_function_t -.

This function handles:

• OP_EDITOR_COMPLETE
• OP_EDITOR_COMPLETE_QUERY
• OP_EDITOR_MAILBOX_CYCLE

Definition at line 192 of file functions.c.

{
  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;
}

Here is the call graph for this function:

op_editor_history_down()

static int op_editor_history_down ( struct EnterFunctionData * fdata, const struct KeyEvent * event )

static

Scroll down through the history list - Implements enter_function_t -.

Definition at line 217 of file functions.c.

{
  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;
}

Here is the call graph for this function:

op_editor_history_search()

static int op_editor_history_search ( struct EnterFunctionData * fdata, const struct KeyEvent * event )

static

Search through the history list - Implements enter_function_t -.

Definition at line 237 of file functions.c.

{
  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;
}

Here is the call graph for this function:

op_editor_history_up()

static int op_editor_history_up ( struct EnterFunctionData * fdata, const struct KeyEvent * event )

static

Scroll up through the history list - Implements enter_function_t -.

Definition at line 254 of file functions.c.

{
  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;
}

Here is the call graph for this function:

op_editor_backspace()

static int op_editor_backspace ( struct EnterFunctionData * fdata, const struct KeyEvent * event )

static

Delete the char in front of the cursor - Implements enter_function_t -.

Definition at line 276 of file functions.c.

{
  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;
}

Here is the call graph for this function:

op_editor_backward_char()

static int op_editor_backward_char ( struct EnterFunctionData * fdata, const struct KeyEvent * event )

static

Move the cursor one character to the left - Implements enter_function_t -.

Definition at line 298 of file functions.c.

{
  struct EnterWindowData *wdata = fdata->wdata;
  return editor_backward_char(wdata->state);
}

Here is the call graph for this function:

op_editor_backward_word()

static int op_editor_backward_word ( struct EnterFunctionData * fdata, const struct KeyEvent * event )

static

Move the cursor to the beginning of the word - Implements enter_function_t -.

Definition at line 307 of file functions.c.

{
  struct EnterWindowData *wdata = fdata->wdata;
  return editor_backward_word(wdata->state);
}

Here is the call graph for this function:

op_editor_bol()

static int op_editor_bol ( struct EnterFunctionData * fdata, const struct KeyEvent * event )

static

Jump to the beginning of the line - Implements enter_function_t -.

Definition at line 316 of file functions.c.

{
  struct EnterWindowData *wdata = fdata->wdata;
  return editor_bol(wdata->state);
}

Here is the call graph for this function:

op_editor_capitalize_word()

static int op_editor_capitalize_word ( struct EnterFunctionData * fdata, const struct KeyEvent * event )

static

Capitalize the word - Implements enter_function_t - This function handles:

• OP_EDITOR_CAPITALIZE_WORD
• OP_EDITOR_DOWNCASE_WORD
• OP_EDITOR_UPCASE_WORD

Definition at line 329 of file functions.c.

{
  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);
}

Here is the call graph for this function:

op_editor_delete_char()

static int op_editor_delete_char ( struct EnterFunctionData * fdata, const struct KeyEvent * event )

static

Delete the char under the cursor - Implements enter_function_t -.

Definition at line 354 of file functions.c.

{
  struct EnterWindowData *wdata = fdata->wdata;
  return editor_delete_char(wdata->state);
}

Here is the call graph for this function:

op_editor_eol()

static int op_editor_eol ( struct EnterFunctionData * fdata, const struct KeyEvent * event )

static

Jump to the end of the line - Implements enter_function_t -.

Definition at line 363 of file functions.c.

{
  struct EnterWindowData *wdata = fdata->wdata;
  int rc = editor_eol(wdata->state);
  wdata->redraw = ENTER_REDRAW_INIT;
  return rc;
}

Here is the call graph for this function:

op_editor_forward_char()

static int op_editor_forward_char ( struct EnterFunctionData * fdata, const struct KeyEvent * event )

static

Move the cursor one character to the right - Implements enter_function_t -.

Definition at line 374 of file functions.c.

{
  struct EnterWindowData *wdata = fdata->wdata;
  return editor_forward_char(wdata->state);
}

Here is the call graph for this function:

op_editor_forward_word()

static int op_editor_forward_word ( struct EnterFunctionData * fdata, const struct KeyEvent * event )

static

Move the cursor to the end of the word - Implements enter_function_t -.

Definition at line 383 of file functions.c.

{
  struct EnterWindowData *wdata = fdata->wdata;
  return editor_forward_word(wdata->state);
}

Here is the call graph for this function:

op_editor_kill_eol()

static int op_editor_kill_eol ( struct EnterFunctionData * fdata, const struct KeyEvent * event )

static

Delete chars from cursor to end of line - Implements enter_function_t -.

Definition at line 392 of file functions.c.

{
  struct EnterWindowData *wdata = fdata->wdata;
  return editor_kill_eol(wdata->state);
}

Here is the call graph for this function:

op_editor_kill_eow()

static int op_editor_kill_eow ( struct EnterFunctionData * fdata, const struct KeyEvent * event )

static

Delete chars from the cursor to the end of the word - Implements enter_function_t -.

Definition at line 401 of file functions.c.

{
  struct EnterWindowData *wdata = fdata->wdata;
  return editor_kill_eow(wdata->state);
}

Here is the call graph for this function:

op_editor_kill_line()

static int op_editor_kill_line ( struct EnterFunctionData * fdata, const struct KeyEvent * event )

static

Delete all chars on the line - Implements enter_function_t -.

Definition at line 410 of file functions.c.

{
  struct EnterWindowData *wdata = fdata->wdata;
  return editor_kill_line(wdata->state);
}

Here is the call graph for this function:

op_editor_kill_whole_line()

static int op_editor_kill_whole_line ( struct EnterFunctionData * fdata, const struct KeyEvent * event )

static

Delete all chars on the line - Implements enter_function_t -.

Definition at line 419 of file functions.c.

{
  struct EnterWindowData *wdata = fdata->wdata;
  return editor_kill_whole_line(wdata->state);
}

Here is the call graph for this function:

op_editor_kill_word()

static int op_editor_kill_word ( struct EnterFunctionData * fdata, const struct KeyEvent * event )

static

Delete the word in front of the cursor - Implements enter_function_t -.

Definition at line 429 of file functions.c.

{
  struct EnterWindowData *wdata = fdata->wdata;
  return editor_kill_word(wdata->state);
}

Here is the call graph for this function:

op_editor_quote_char()

static int op_editor_quote_char ( struct EnterFunctionData * fdata, const struct KeyEvent * event )

static

Quote the next typed key - Implements enter_function_t -.

As part of the line-editor, this function uses the message window.

See also

GUI: Message Windows

Definition at line 442 of file functions.c.

{
  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;
}

Here is the call graph for this function:

op_editor_transpose_chars()

static int op_editor_transpose_chars ( struct EnterFunctionData * fdata, const struct KeyEvent * event )

static

Transpose character under cursor with previous - Implements enter_function_t -.

Definition at line 466 of file functions.c.

{
  struct EnterWindowData *wdata = fdata->wdata;
  return editor_transpose_chars(wdata->state);
}

Here is the call graph for this function:

op_help()

static int op_help ( struct EnterFunctionData * fdata, const struct KeyEvent * event )

static

Display Help - Implements enter_function_t -.

Definition at line 476 of file functions.c.

{
  mutt_help(fdata->mod_data->md_editor);
  return FR_SUCCESS;
}

Here is the call graph for this function:

op_redraw()

static int op_redraw ( struct EnterFunctionData * fdata, const struct KeyEvent * event )

static

Redraw the screen - Implements enter_function_t -.

Definition at line 485 of file functions.c.

{
  mutt_clear_error();
  clearok(stdscr, true);
  mutt_resize_screen();
  window_invalidate_all();
  window_redraw(NULL);
  return FR_SUCCESS;
}

Here is the call graph for this function: