complete.c File Reference

Notmuch Auto-Completion. More...

#include "config.h"
#include <notmuch.h>
#include <stdbool.h>
#include <stdio.h>
#include <string.h>
#include "private.h"
#include "mutt/lib.h"
#include "config/lib.h"
#include "core/lib.h"
#include "gui/lib.h"
#include "lib.h"
#include "complete/lib.h"
#include "editor/lib.h"
#include "index/lib.h"

Include dependency graph for complete.c:

Go to the source code of this file.

Functions
static void	nm_complete_data_init (struct CompletionData *cd, const char *pt)
	Reset the completion state for a tag lookup.
static int	complete_all_nm_tags_fresh (struct CompletionData *cd)
	Query notmuch directly for a fresh tag list.
int	complete_all_nm_tags (struct CompletionData *cd, const char *pt)
	Pass a list of Notmuch tags to the completion code.
bool	mutt_nm_query_complete (struct CompletionData *cd, struct Buffer *buf, int numtabs)
	Complete to the nearest notmuch tag.
bool	mutt_nm_tag_complete (struct CompletionData *cd, struct Buffer *buf, int numtabs)
	Complete to the nearest notmuch tag.
enum FunctionRetval	complete_nm_query (struct EnterWindowData *wdata, int op)
	Complete a Notmuch Query - Implements CompleteOps::complete() -.
enum FunctionRetval	complete_nm_tag (struct EnterWindowData *wdata, int op)
	Complete a Notmuch Tag - Implements CompleteOps::complete() -.

Variables
const struct CompleteOps	CompleteNmQueryOps
	Auto-Completion of NmQuerys.
const struct CompleteOps	CompleteNmTagOps
	Auto-Completion of NmTags.

Detailed Description

Notmuch Auto-Completion.

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 complete.c.

Function Documentation

nm_complete_data_init()

static void nm_complete_data_init ( struct CompletionData * cd, const char * pt )

static

Reset the completion state for a tag lookup.

Parameters

cd	Completion Data
pt	User input being completed

Definition at line 49 of file complete.c.

{
  completion_data_free_match_strings(cd);
  mutt_str_copy(cd->user_typed, pt, sizeof(cd->user_typed));
  memset(cd->match_list, 0, cd->match_list_len * sizeof(const char *));
  memset(cd->completed, 0, sizeof(cd->completed));
  cd->num_matched = 0;
  cd->free_match_strings = true;
}

Here is the call graph for this function:

Here is the caller graph for this function:

complete_all_nm_tags_fresh()

static int complete_all_nm_tags_fresh ( struct CompletionData * cd )

static

Query notmuch directly for a fresh tag list.

Parameters

cd	Completion Data

Return values

0	Success
-1	Error

Definition at line 65 of file complete.c.

{
  int rc = -1;
  struct Mailbox *m_cur = get_current_mailbox();
  notmuch_database_t *db = NULL;
  notmuch_tags_t *tags = NULL;
  const char *db_filename = nm_db_get_filename(m_cur);
 
#if !LIBNOTMUCH_CHECK_VERSION(5, 4, 0)
  if (!db_filename)
    db_filename = cs_subset_string(NeoMutt->sub, "folder");
#endif
 
  if (!(db = nm_db_do_open(db_filename, false, false)) ||
      !(tags = notmuch_database_get_all_tags(db)))
  {
    goto done;
  }
 
  while (notmuch_tags_valid(tags))
  {
    const char *tag = notmuch_tags_get(tags);
 
    /* Keep a private copy because notmuch owns the iterator storage. */
    if (*tag && candidate(cd, cd->user_typed, tag, cd->completed, sizeof(cd->completed)))
      cd->match_list[cd->num_matched - 1] = mutt_str_dup(tag);
 
    notmuch_tags_move_to_next(tags);
  }
 
  rc = 0;
 
done:
  if (tags)
    notmuch_tags_destroy(tags);
  if (db)
    nm_db_free(db);
 
  return rc;
}

Here is the call graph for this function:

Here is the caller graph for this function:

complete_all_nm_tags()

int complete_all_nm_tags	(	struct CompletionData *	cd,
		const char *	pt )

Pass a list of Notmuch tags to the completion code.

Parameters

cd	Completion Data
pt	User input being completed

Return values

0	Success
-1	Error

Definition at line 113 of file complete.c.

{
  int rc = -1;
 
  nm_complete_data_init(cd, pt);
  rc = complete_all_nm_tags_fresh(cd);
  if (rc == 0)
  {
    matches_ensure_morespace(cd, cd->num_matched);
    cd->match_list[cd->num_matched++] = mutt_str_dup(cd->user_typed);
  }
 
  return rc;
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_nm_query_complete()

bool mutt_nm_query_complete	(	struct CompletionData *	cd,
		struct Buffer *	buf,
		int	numtabs )

Complete to the nearest notmuch tag.

Parameters

cd	Completion Data
buf	Buffer for the result
numtabs	Number of times the user has hit 'tab'

Return values

true	Success, a match
false	Error, no match

Complete the last "tag:"-prefixed string.

Definition at line 138 of file complete.c.

{
  char *pt = buf->data;
  int spaces;
 
  SKIPWS(pt);
  spaces = pt - buf->data;
 
  pt = (char *) buf_rfind(buf, "tag:");
  if (pt)
  {
    pt += 4;
    if (numtabs == 1)
    {
      /* First TAB. Collect all the matches */
      complete_all_nm_tags(cd, pt);
 
      /* All matches are stored. Longest non-ambiguous string is ""
       * i.e. don't change 'buf'. Fake successful return this time.  */
      if (cd->user_typed[0] == '\0')
        return true;
    }
 
    if ((cd->completed[0] == '\0') && (cd->user_typed[0] != '\0'))
      return false;
 
    /* cd->num_matched will _always_ be at least 1 since the initial
     * user-typed string is always stored */
    if ((numtabs == 1) && (cd->num_matched == 2))
    {
      snprintf(cd->completed, sizeof(cd->completed), "%s", NONULL(cd->match_list[0]));
    }
    else if ((numtabs > 1) && (cd->num_matched > 2))
    {
      /* cycle through all the matches */
      snprintf(cd->completed, sizeof(cd->completed), "%s",
               NONULL(cd->match_list[(numtabs - 2) % cd->num_matched]));
    }
 
    /* return the completed query */
    strncpy(pt, cd->completed, buf->data + buf->dsize - pt - spaces);
  }
  else
  {
    return false;
  }
 
  return true;
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_nm_tag_complete()

bool mutt_nm_tag_complete	(	struct CompletionData *	cd,
		struct Buffer *	buf,
		int	numtabs )

Complete to the nearest notmuch tag.

Parameters

cd	Completion Data
buf	Buffer for the result
numtabs	Number of times the user has hit 'tab'

Return values

true	Success, a match
false	Error, no match

Complete the nearest "+" or "-" -prefixed string previous to pos.

Definition at line 198 of file complete.c.

{
  if (!buf)
    return false;
 
  char *pt = buf->data;
 
  /* Only examine the last token */
  char *last_space = strrchr(buf->data, ' ');
  if (last_space)
    pt = (last_space + 1);
 
  /* Skip the +/- */
  if ((pt[0] == '+') || (pt[0] == '-'))
    pt++;
 
  if (numtabs == 1)
  {
    /* First TAB. Collect all the matches */
    complete_all_nm_tags(cd, pt);
 
    /* All matches are stored. Longest non-ambiguous string is ""
     * i.e. don't change 'buf'. Fake successful return this time.  */
    if (cd->user_typed[0] == '\0')
      return true;
  }
 
  if ((cd->completed[0] == '\0') && (cd->user_typed[0] != '\0'))
    return false;
 
  /* cd->num_matched will _always_ be at least 1 since the initial
   * user-typed string is always stored */
  if ((numtabs == 1) && (cd->num_matched == 2))
  {
    snprintf(cd->completed, sizeof(cd->completed), "%s", NONULL(cd->match_list[0]));
  }
  else if ((numtabs > 1) && (cd->num_matched > 2))
  {
    /* cycle through all the matches */
    snprintf(cd->completed, sizeof(cd->completed), "%s",
             NONULL(cd->match_list[(numtabs - 2) % cd->num_matched]));
  }
 
  /* return the completed query */
  strncpy(pt, cd->completed, buf->data + buf->dsize - pt);
 
  return true;
}

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

CompleteNmQueryOps

const struct CompleteOps CompleteNmQueryOps

Initial value:

= {
  .complete = complete_nm_query,
}

Auto-Completion of NmQuerys.

Definition at line 284 of file complete.c.

                                              {
  .complete = complete_nm_query,
};

CompleteNmTagOps

const struct CompleteOps CompleteNmTagOps

Initial value:

= {
  .complete = complete_nm_tag,
}

Auto-Completion of NmTags.

Definition at line 291 of file complete.c.

                                            {
  .complete = complete_nm_tag,
};