Auto-Completion API

Auto-Completion API. More...

Collaboration diagram for Auto-Completion API:

Modules
	complete()
	Perform Auto-Completion.

Functions
int	complete_alias_complete (struct EnterWindowData *wdata, int op)
	Complete an Alias - Implements complete_function_t -.
int	complete_alias_query (struct EnterWindowData *wdata, int op)
	Complete an Alias Query - Implements complete_function_t -.
int	complete_alias (struct EnterWindowData *wdata, int op)
	Alias completion wrapper - Implements complete_function_t -.
int	complete_file_mbox (struct EnterWindowData *wdata, int op)
	Complete a Mailbox - Implements complete_function_t -.
int	complete_file_simple (struct EnterWindowData *wdata, int op)
	Complete a filename - Implements complete_function_t -.
int	complete_command (struct EnterWindowData *wdata, int op)
	Complete a NeoMutt Command - Implements complete_function_t -.
int	complete_label (struct EnterWindowData *wdata, int op)
	Complete a label - Implements complete_function_t -.
int	complete_nm_query (struct EnterWindowData *wdata, int op)
	Complete a Notmuch Query - Implements complete_function_t -.
int	complete_nm_tag (struct EnterWindowData *wdata, int op)
	Complete a Notmuch Tag - Implements complete_function_t -.
int	complete_pattern (struct EnterWindowData *wdata, int op)
	Complete a NeoMutt Pattern - Implements complete_function_t -.

Detailed Description

Auto-Completion API.

Prototype for an Auto-Completion Function.

Parameters

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

Return values

num	FunctionRetval, e.g. FR_SUCCESS

Function Documentation

complete_alias_complete()

int complete_alias_complete	(	struct EnterWindowData *	wdata,
		int	op
	)

Complete an Alias - Implements complete_function_t -.

Definition at line 41 of file complete.c.

{
  if (!wdata || (op != OP_EDITOR_COMPLETE))
    return FR_NO_ACTION;
 
  /* 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
 
  buf_mb_wcstombs(wdata->buffer, wdata->state->wbuf + i, wdata->state->curpos - i);
  int rc = alias_complete(wdata->buffer, NeoMutt->sub);
  replace_part(wdata->state, i, buf_string(wdata->buffer));
  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_alias_query()

int complete_alias_query	(	struct EnterWindowData *	wdata,
		int	op
	)

Complete an Alias Query - Implements complete_function_t -.

Definition at line 70 of file complete.c.

{
  if (!wdata || (op != OP_EDITOR_COMPLETE_QUERY))
    return FR_NO_ACTION;
 
  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
  }
 
  buf_mb_wcstombs(wdata->buffer, wdata->state->wbuf + i, wdata->state->curpos - i);
  query_complete(wdata->buffer, NeoMutt->sub);
  replace_part(wdata->state, i, buf_string(wdata->buffer));
 
  return FR_CONTINUE;
}

Here is the call graph for this function:

Here is the caller graph for this function:

complete_alias()

int complete_alias	(	struct EnterWindowData *	wdata,
		int	op
	)

Alias completion wrapper - Implements complete_function_t -.

Definition at line 95 of file complete.c.

{
  if (op == OP_EDITOR_COMPLETE)
    return complete_alias_complete(wdata, op);
  if (op == OP_EDITOR_COMPLETE_QUERY)
    return complete_alias_query(wdata, op);
 
  return FR_NO_ACTION;
}

Here is the call graph for this function:

complete_file_mbox()

int complete_file_mbox	(	struct EnterWindowData *	wdata,
		int	op
	)

Complete a Mailbox - Implements complete_function_t -.

Definition at line 46 of file complete.c.

{
  if (!wdata)
    return FR_NO_ACTION;
 
  struct FileCompletionData *cdata = wdata->cdata;
 
  if (op == OP_EDITOR_MAILBOX_CYCLE)
  {
    wdata->first = true; /* clear input if user types a real key later */
    buf_mb_wcstombs(wdata->buffer, wdata->state->wbuf, wdata->state->curpos);
    mutt_mailbox_next(cdata->mailbox, wdata->buffer);
 
    wdata->state->curpos = wdata->state->lastchar = mutt_mb_mbstowcs(
        &wdata->state->wbuf, &wdata->state->wbuflen, 0, buf_string(wdata->buffer));
    return FR_SUCCESS;
  }
 
  if ((op != OP_EDITOR_COMPLETE) && (op != OP_EDITOR_COMPLETE_QUERY))
    return FR_NO_ACTION;
 
  int rc = FR_SUCCESS;
  buf_mb_wcstombs(wdata->buffer, 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)))
  {
    SelectFileFlags flags = MUTT_SEL_NO_FLAGS;
    if (wdata->hclass == HC_MAILBOX)
      flags |= MUTT_SEL_FOLDER;
    if (cdata->multiple)
      flags |= MUTT_SEL_MULTI;
 
    dlg_browser(wdata->buffer, flags, cdata->mailbox, cdata->files, cdata->numfiles);
    if (!buf_is_empty(wdata->buffer))
    {
      buf_pretty_mailbox(wdata->buffer);
      if (!wdata->pass)
        mutt_hist_add(wdata->hclass, buf_string(wdata->buffer), true);
      wdata->done = true;
      return FR_SUCCESS;
    }
 
    /* file selection cancelled */
    return FR_CONTINUE;
  }
 
  if (mutt_complete(wdata->cd, wdata->buffer) == 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, buf_string(wdata->buffer));
  return rc;
}

Here is the call graph for this function:

complete_file_simple()

int complete_file_simple	(	struct EnterWindowData *	wdata,
		int	op
	)

Complete a filename - Implements complete_function_t -.

Definition at line 113 of file complete.c.

{
  if (!wdata || ((op != OP_EDITOR_COMPLETE) && (op != OP_EDITOR_COMPLETE_QUERY)))
    return FR_NO_ACTION;
 
  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--)
  {
  }
  buf_mb_wcstombs(wdata->buffer, 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))
  {
    dlg_browser(wdata->buffer, MUTT_SEL_NO_FLAGS, NULL, NULL, NULL);
    if (!buf_is_empty(wdata->buffer))
      replace_part(wdata->state, i, buf_string(wdata->buffer));
    return FR_CONTINUE;
  }
 
  if (mutt_complete(wdata->cd, wdata->buffer) == 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, buf_string(wdata->buffer));
  return rc;
}

Here is the call graph for this function:

complete_command()

int complete_command	(	struct EnterWindowData *	wdata,
		int	op
	)

Complete a NeoMutt Command - Implements complete_function_t -.

Definition at line 424 of file helpers.c.

{
  if (!wdata || ((op != OP_EDITOR_COMPLETE) && (op != OP_EDITOR_COMPLETE_QUERY)))
    return FR_NO_ACTION;
 
  int rc = FR_SUCCESS;
  buf_mb_wcstombs(wdata->buffer, wdata->state->wbuf, wdata->state->curpos);
  size_t i = buf_len(wdata->buffer);
  if ((i != 0) && (buf_at(wdata->buffer, i - 1) == '=') &&
      (mutt_var_value_complete(wdata->cd, wdata->buffer, i) != 0))
  {
    wdata->tabs = 0;
  }
  else if (mutt_command_complete(wdata->cd, wdata->buffer, i, wdata->tabs) == 0)
  {
    rc = FR_ERROR;
  }
 
  replace_part(wdata->state, 0, buf_string(wdata->buffer));
  return rc;
}

Here is the call graph for this function:

complete_label()

int complete_label	(	struct EnterWindowData *	wdata,
		int	op
	)

Complete a label - Implements complete_function_t -.

Definition at line 449 of file helpers.c.

{
  if (!wdata || ((op != OP_EDITOR_COMPLETE) && (op != OP_EDITOR_COMPLETE_QUERY)))
    return FR_NO_ACTION;
 
  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
 
  buf_mb_wcstombs(wdata->buffer, wdata->state->wbuf + i, wdata->state->curpos - i);
  int rc = mutt_label_complete(wdata->cd, wdata->buffer, wdata->tabs);
  replace_part(wdata->state, i, buf_string(wdata->buffer));
  if (rc != 1)
    return FR_CONTINUE;
 
  return FR_SUCCESS;
}

Here is the call graph for this function:

complete_nm_query()

int complete_nm_query	(	struct EnterWindowData *	wdata,
		int	op
	)

Complete a Notmuch Query - Implements complete_function_t -.

Definition at line 214 of file complete.c.

{
  if (!wdata || ((op != OP_EDITOR_COMPLETE) && (op != OP_EDITOR_COMPLETE_QUERY)))
    return FR_NO_ACTION;
 
  int rc = FR_SUCCESS;
  buf_mb_wcstombs(wdata->buffer, wdata->state->wbuf, wdata->state->curpos);
  size_t len = buf_len(wdata->buffer);
  if (!mutt_nm_query_complete(wdata->cd, wdata->buffer, len, wdata->tabs))
    rc = FR_ERROR;
 
  replace_part(wdata->state, 0, buf_string(wdata->buffer));
  return rc;
}

Here is the call graph for this function:

complete_nm_tag()

int complete_nm_tag	(	struct EnterWindowData *	wdata,
		int	op
	)

Complete a Notmuch Tag - Implements complete_function_t -.

Definition at line 232 of file complete.c.

{
  if (!wdata || ((op != OP_EDITOR_COMPLETE) && (op != OP_EDITOR_COMPLETE_QUERY)))
    return FR_NO_ACTION;
 
  int rc = FR_SUCCESS;
  buf_mb_wcstombs(wdata->buffer, wdata->state->wbuf, wdata->state->curpos);
  if (!mutt_nm_tag_complete(wdata->cd, wdata->buffer, wdata->tabs))
    rc = FR_ERROR;
 
  replace_part(wdata->state, 0, buf_string(wdata->buffer));
  return rc;
}

Here is the call graph for this function:

complete_pattern()

int complete_pattern	(	struct EnterWindowData *	wdata,
		int	op
	)

Complete a NeoMutt Pattern - Implements complete_function_t -.

Definition at line 41 of file complete.c.

{
  if (!wdata || ((op != OP_EDITOR_COMPLETE) && (op != OP_EDITOR_COMPLETE_QUERY)))
    return FR_NO_ACTION;
 
  size_t i = wdata->state->curpos;
  if (i && (wdata->state->wbuf[i - 1] == '~'))
  {
    if (dlg_pattern(wdata->buffer->data, wdata->buffer->dsize))
      replace_part(wdata->state, i - 1, wdata->buffer->data);
    buf_fix_dptr(wdata->buffer);
    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++;
    buf_mb_wcstombs(wdata->buffer, wdata->state->wbuf + i, wdata->state->curpos - i);
    int rc = mutt_label_complete(wdata->cd, wdata->buffer, wdata->tabs);
    replace_part(wdata->state, i, wdata->buffer->data);
    buf_fix_dptr(wdata->buffer);
    if (rc != 1)
    {
      return FR_CONTINUE;
    }
  }
  else
  {
    return FR_NO_ACTION;
  }
 
  return FR_SUCCESS;
}

Here is the call graph for this function: