Enter Function API

Prototype for a Enter Function. More...

Functions
static int	op_editor_complete (struct EnterWindowData *wdata, int op)
	Complete filename or alias - Implements enter_function_t -.
static int	op_editor_history_down (struct EnterWindowData *wdata, int op)
	Scroll down through the history list - Implements enter_function_t -.
static int	op_editor_history_search (struct EnterWindowData *wdata, int op)
	Search through the history list - Implements enter_function_t -.
static int	op_editor_history_up (struct EnterWindowData *wdata, int op)
	Scroll up through the history list - Implements enter_function_t -.
static int	op_editor_backspace (struct EnterWindowData *wdata, int op)
	Delete the char in front of the cursor - Implements enter_function_t -.
static int	op_editor_backward_char (struct EnterWindowData *wdata, int op)
	Move the cursor one character to the left - Implements enter_function_t -.
static int	op_editor_backward_word (struct EnterWindowData *wdata, int op)
	Move the cursor to the beginning of the word - Implements enter_function_t -.
static int	op_editor_bol (struct EnterWindowData *wdata, int op)
	Jump to the beginning of the line - Implements enter_function_t -.
static int	op_editor_capitalize_word (struct EnterWindowData *wdata, int op)
	Capitalize the word - Implements enter_function_t - This function handles:
static int	op_editor_delete_char (struct EnterWindowData *wdata, int op)
	Delete the char under the cursor - Implements enter_function_t -.
static int	op_editor_eol (struct EnterWindowData *wdata, int op)
	Jump to the end of the line - Implements enter_function_t -.
static int	op_editor_forward_char (struct EnterWindowData *wdata, int op)
	Move the cursor one character to the right - Implements enter_function_t -.
static int	op_editor_forward_word (struct EnterWindowData *wdata, int op)
	Move the cursor to the end of the word - Implements enter_function_t -.
static int	op_editor_kill_eol (struct EnterWindowData *wdata, int op)
	Delete chars from cursor to end of line - Implements enter_function_t -.
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 -.
static int	op_editor_kill_line (struct EnterWindowData *wdata, int op)
	Delete all chars on the line - Implements enter_function_t -.
static int	op_editor_kill_whole_line (struct EnterWindowData *wdata, int op)
	Delete all chars on the line - Implements enter_function_t -.
static int	op_editor_kill_word (struct EnterWindowData *wdata, int op)
	Delete the word in front of the cursor - Implements enter_function_t -.
static int	op_editor_quote_char (struct EnterWindowData *wdata, int op)
	Quote the next typed key - Implements enter_function_t -.
static int	op_editor_transpose_chars (struct EnterWindowData *wdata, int op)
	Transpose character under cursor with previous - Implements enter_function_t -.
static int	op_help (struct EnterWindowData *wdata, int op)
	Display Help - Implements enter_function_t -.
static int	op_redraw (struct EnterWindowData *wdata, int op)
	Redraw the screen - Implements enter_function_t -.

Detailed Description

Prototype for a Enter Function.

Parameters

wdata	Enter Window data
op	Operation to perform, e.g. OP_ENTER_NEXT

Return values

enum	FunctionRetval

Function Documentation

op_editor_complete()

static int op_editor_complete ( struct EnterWindowData *  wdata, int  op  )

static

Complete filename or alias - Implements enter_function_t -.

This function handles:

• OP_EDITOR_COMPLETE
• OP_EDITOR_COMPLETE_QUERY

Definition at line 174 of file functions.c.

{
  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, op);
 
  return FR_NO_ACTION;
}

Here is the call graph for this function:

op_editor_history_down()

static int op_editor_history_down ( struct EnterWindowData *  wdata, int  op  )

static

Scroll down through the history list - Implements enter_function_t -.

Definition at line 198 of file functions.c.

{
  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 EnterWindowData *  wdata, int  op  )

static

Search through the history list - Implements enter_function_t -.

Definition at line 214 of file functions.c.

{
  wdata->state->curpos = wdata->state->lastchar;
  buf_mb_wcstombs(wdata->buffer, wdata->state->wbuf, wdata->state->curpos);
  mutt_hist_complete(wdata->buffer->data, wdata->buffer->dsize, 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 EnterWindowData *  wdata, int  op  )

static

Scroll up through the history list - Implements enter_function_t -.

Definition at line 226 of file functions.c.

{
  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 EnterWindowData *  wdata, int  op  )

static

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

Definition at line 244 of file functions.c.

{
  int rc = editor_backspace(wdata->state);
 
  if ((rc == FR_ERROR) && editor_buffer_is_empty(wdata->state))
  {
    const bool c_abort_backspace = cs_subset_bool(NeoMutt->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 EnterWindowData *  wdata, int  op  )

static

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

Definition at line 265 of file functions.c.

{
  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 EnterWindowData *  wdata, int  op  )

static

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

Definition at line 273 of file functions.c.

{
  return editor_backward_word(wdata->state);
}

Here is the call graph for this function:

op_editor_bol()

static int op_editor_bol ( struct EnterWindowData *  wdata, int  op  )

static

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

Definition at line 281 of file functions.c.

{
  return editor_bol(wdata->state);
}

Here is the call graph for this function:

op_editor_capitalize_word()

static int op_editor_capitalize_word ( struct EnterWindowData *  wdata, int  op  )

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 293 of file functions.c.

{
  enum EnterCase ec;
  switch (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 EnterWindowData *  wdata, int  op  )

static

Delete the char under the cursor - Implements enter_function_t -.

Definition at line 316 of file functions.c.

{
  return editor_delete_char(wdata->state);
}

Here is the call graph for this function:

op_editor_eol()

static int op_editor_eol ( struct EnterWindowData *  wdata, int  op  )

static

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

Definition at line 324 of file functions.c.

{
  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 EnterWindowData *  wdata, int  op  )

static

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

Definition at line 334 of file functions.c.

{
  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 EnterWindowData *  wdata, int  op  )

static

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

Definition at line 342 of file functions.c.

{
  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 EnterWindowData *  wdata, int  op  )

static

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

Definition at line 350 of file functions.c.

{
  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 EnterWindowData *  wdata, int  op  )

static

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

Definition at line 358 of file functions.c.

{
  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 EnterWindowData *  wdata, int  op  )

static

Delete all chars on the line - Implements enter_function_t -.

Definition at line 366 of file functions.c.

{
  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 EnterWindowData *  wdata, int  op  )

static

Delete all chars on the line - Implements enter_function_t -.

Definition at line 374 of file functions.c.

{
  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 EnterWindowData *  wdata, int  op  )

static

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

Definition at line 382 of file functions.c.

{
  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 EnterWindowData *  wdata, int  op  )

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 394 of file functions.c.

{
  struct KeyEvent event = { 0, OP_NULL };
  do
  {
    window_redraw(NULL);
    event = mutt_getch(GETCH_NO_FLAGS);
  } while ((event.op == OP_TIMEOUT) || (event.op == OP_REPAINT));
 
  if (event.op != OP_ABORT)
  {
    if (self_insert(wdata, event.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 EnterWindowData *  wdata, int  op  )

static

Transpose character under cursor with previous - Implements enter_function_t -.

Definition at line 417 of file functions.c.

{
  return editor_transpose_chars(wdata->state);
}

Here is the call graph for this function:

op_help()

static int op_help ( struct EnterWindowData *  wdata, int  op  )

static

Display Help - Implements enter_function_t -.

Definition at line 425 of file functions.c.

{
  mutt_help(MENU_EDITOR);
  return FR_SUCCESS;
}

Here is the call graph for this function:

op_redraw()

static int op_redraw ( struct EnterWindowData *  wdata, int  op  )

static

Redraw the screen - Implements enter_function_t -.

Definition at line 434 of file functions.c.

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

Here is the call graph for this function: