NeoMutt  2025-09-05-43-g177ed6
Teaching an old dog new tricks
DOXYGEN
Loading...
Searching...
No Matches
lib.h File Reference

Auto-completion. More...

#include <stdbool.h>
#include <stddef.h>
#include "compapi.h"
#include "data.h"
+ Include dependency graph for lib.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions

int mutt_command_complete (struct CompletionData *cd, struct Buffer *buf, int pos, int numtabs)
 Complete a command name.
 
int mutt_complete (struct CompletionData *cd, struct Buffer *buf)
 Attempt to complete a partial pathname.
 
int mutt_label_complete (struct CompletionData *cd, struct Buffer *buf, int numtabs)
 Complete a label name.
 
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.
 
int mutt_var_value_complete (struct CompletionData *cd, struct Buffer *buf, int pos)
 Complete a variable/value.
 
void matches_ensure_morespace (struct CompletionData *cd, int new_size)
 Allocate more space for auto-completion.
 
bool candidate (struct CompletionData *cd, char *user, const char *src, char *dest, size_t dlen)
 Helper function for completion.
 

Variables

const struct CompleteOps CompleteCommandOps
 Auto-Completion of Commands.
 
const struct CompleteOps CompleteLabelOps
 Auto-Completion of Labels.
 

Detailed Description

Auto-completion.

Authors
  • Richard Russon
  • Anna Figueiredo Gomes

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 lib.h.

Function Documentation

◆ mutt_command_complete()

int mutt_command_complete ( struct CompletionData * cd,
struct Buffer * buf,
int pos,
int numtabs )

Complete a command name.

Parameters
cdCompletion Data
bufBuffer for the result
posCursor position in the buffer
numtabsNumber of times the user has hit 'tab'
Return values
1Success, a match
0Error, no match

Definition at line 111 of file helpers.c.

112{
113 char *pt = buf->data;
114 int spaces; /* keep track of the number of leading spaces on the line */
115
116 SKIPWS(pt);
117 spaces = pt - buf->data;
118
119 pt = buf->data + pos - spaces;
120 while ((pt > buf->data) && !mutt_isspace(*pt))
121 pt--;
122
123 if (pt == buf->data) /* complete cmd */
124 {
125 /* first TAB. Collect all the matches */
126 if (numtabs == 1)
127 {
128 cd->num_matched = 0;
129 mutt_str_copy(cd->user_typed, pt, sizeof(cd->user_typed));
130 memset(cd->match_list, 0, cd->match_list_len);
131 memset(cd->completed, 0, sizeof(cd->completed));
132
133 const struct Command **cp = NULL;
135 {
136 const struct Command *cmd = *cp;
137
138 candidate(cd, cd->user_typed, cmd->name, cd->completed, sizeof(cd->completed));
139 }
140
142 cd->match_list[cd->num_matched++] = cd->user_typed;
143
144 /* All matches are stored. Longest non-ambiguous string is ""
145 * i.e. don't change 'buf'. Fake successful return this time */
146 if (cd->user_typed[0] == '\0')
147 return 1;
148 }
149
150 if ((cd->completed[0] == '\0') && (cd->user_typed[0] != '\0'))
151 return 0;
152
153 /* cd->num_matched will _always_ be at least 1 since the initial
154 * user-typed string is always stored */
155 if ((numtabs == 1) && (cd->num_matched == 2))
156 {
157 snprintf(cd->completed, sizeof(cd->completed), "%s", cd->match_list[0]);
158 }
159 else if ((numtabs > 1) && (cd->num_matched > 2))
160 {
161 /* cycle through all the matches */
162 snprintf(cd->completed, sizeof(cd->completed), "%s",
163 cd->match_list[(numtabs - 2) % cd->num_matched]);
164 }
165
166 /* return the completed command */
167 buf_strcpy(buf, cd->completed);
168 }
169 else if (buf_startswith(buf, "set") || buf_startswith(buf, "unset") ||
170 buf_startswith(buf, "reset") || buf_startswith(buf, "toggle"))
171 { /* complete variables */
172 static const char *const prefixes[] = { "no", "inv", "?", "&", 0 };
173
174 pt++;
175 /* loop through all the possible prefixes (no, inv, ...) */
176 if (buf_startswith(buf, "set"))
177 {
178 for (int num = 0; prefixes[num]; num++)
179 {
180 if (mutt_str_startswith(pt, prefixes[num]))
181 {
182 pt += mutt_str_len(prefixes[num]);
183 break;
184 }
185 }
186 }
187
188 /* first TAB. Collect all the matches */
189 if (numtabs == 1)
190 {
191 cd->num_matched = 0;
192 mutt_str_copy(cd->user_typed, pt, sizeof(cd->user_typed));
193 memset(cd->match_list, 0, cd->match_list_len);
194 memset(cd->completed, 0, sizeof(cd->completed));
195
196 struct HashElemArray hea = get_elem_list(NeoMutt->sub->cs, GEL_ALL_CONFIG);
197 struct HashElem **hep = NULL;
198 ARRAY_FOREACH(hep, &hea)
199 {
200 candidate(cd, cd->user_typed, (*hep)->key.strkey, cd->completed,
201 sizeof(cd->completed));
202 }
203 ARRAY_FREE(&hea);
204
206 cd->match_list[cd->num_matched++] = cd->user_typed;
207
208 /* All matches are stored. Longest non-ambiguous string is ""
209 * i.e. don't change 'buf'. Fake successful return this time */
210 if (cd->user_typed[0] == '\0')
211 return 1;
212 }
213
214 if ((cd->completed[0] == 0) && cd->user_typed[0])
215 return 0;
216
217 /* cd->num_matched will _always_ be at least 1 since the initial
218 * user-typed string is always stored */
219 if ((numtabs == 1) && (cd->num_matched == 2))
220 {
221 snprintf(cd->completed, sizeof(cd->completed), "%s", cd->match_list[0]);
222 }
223 else if ((numtabs > 1) && (cd->num_matched > 2))
224 {
225 /* cycle through all the matches */
226 snprintf(cd->completed, sizeof(cd->completed), "%s",
227 cd->match_list[(numtabs - 2) % cd->num_matched]);
228 }
229
230 strncpy(pt, cd->completed, buf->data + buf->dsize - pt - spaces);
231 buf_fix_dptr(buf);
232 }
233 else if (buf_startswith(buf, "exec"))
234 {
235 const enum MenuType mtype = menu_get_current_type();
236 const struct MenuFuncOp *funcs = km_get_table(mtype);
237 if (!funcs && (mtype != MENU_PAGER))
238 funcs = OpGeneric;
239
240 pt++;
241 /* first TAB. Collect all the matches */
242 if (numtabs == 1)
243 {
244 cd->num_matched = 0;
245 mutt_str_copy(cd->user_typed, pt, sizeof(cd->user_typed));
246 memset(cd->match_list, 0, cd->match_list_len);
247 memset(cd->completed, 0, sizeof(cd->completed));
248 for (int num = 0; funcs[num].name; num++)
249 candidate(cd, cd->user_typed, funcs[num].name, cd->completed, sizeof(cd->completed));
250 /* try the generic menu */
251 if ((mtype != MENU_PAGER) && (mtype != MENU_GENERIC))
252 {
253 funcs = OpGeneric;
254 for (int num = 0; funcs[num].name; num++)
255 candidate(cd, cd->user_typed, funcs[num].name, cd->completed,
256 sizeof(cd->completed));
257 }
259 cd->match_list[cd->num_matched++] = cd->user_typed;
260
261 /* All matches are stored. Longest non-ambiguous string is ""
262 * i.e. don't change 'buf'. Fake successful return this time */
263 if (cd->user_typed[0] == '\0')
264 return 1;
265 }
266
267 if ((cd->completed[0] == '\0') && (cd->user_typed[0] != '\0'))
268 return 0;
269
270 /* cd->num_matched will _always_ be at least 1 since the initial
271 * user-typed string is always stored */
272 if ((numtabs == 1) && (cd->num_matched == 2))
273 {
274 snprintf(cd->completed, sizeof(cd->completed), "%s", cd->match_list[0]);
275 }
276 else if ((numtabs > 1) && (cd->num_matched > 2))
277 {
278 /* cycle through all the matches */
279 snprintf(cd->completed, sizeof(cd->completed), "%s",
280 cd->match_list[(numtabs - 2) % cd->num_matched]);
281 }
282
283 strncpy(pt, cd->completed, buf->data + buf->dsize - pt - spaces);
284 buf_fix_dptr(buf);
285 }
286 else
287 {
288 return 0;
289 }
290
291 return 1;
292}
#define ARRAY_FOREACH(elem, head)
Iterate over all elements of the array.
Definition array.h:214
#define ARRAY_FREE(head)
Release all memory.
Definition array.h:204
void buf_fix_dptr(struct Buffer *buf)
Move the dptr to end of the Buffer.
Definition buffer.c:182
size_t buf_strcpy(struct Buffer *buf, const char *s)
Copy a string into a Buffer.
Definition buffer.c:395
size_t buf_startswith(const struct Buffer *buf, const char *prefix)
Check whether a buffer starts with a prefix.
Definition buffer.c:707
void matches_ensure_morespace(struct CompletionData *cd, int new_size)
Allocate more space for auto-completion.
Definition helpers.c:53
bool candidate(struct CompletionData *cd, char *user, const char *src, char *dest, size_t dlen)
Helper function for completion.
Definition helpers.c:77
bool mutt_isspace(int arg)
Wrapper for isspace(3)
Definition ctype.c:95
const struct MenuFuncOp OpGeneric[]
Functions for the Generic Menu.
Definition functions.c:69
const struct MenuFuncOp * km_get_table(enum MenuType mtype)
Lookup a Menu's functions.
Definition lib.c:571
enum MenuType menu_get_current_type(void)
Get the type of the current Window.
Definition menu.c:89
size_t mutt_str_startswith(const char *str, const char *prefix)
Check whether a string starts with a prefix.
Definition string.c:232
size_t mutt_str_len(const char *a)
Calculate the length of a string, safely.
Definition string.c:498
size_t mutt_str_copy(char *dest, const char *src, size_t dsize)
Copy a string into a buffer (guaranteeing NUL-termination)
Definition string.c:581
#define SKIPWS(ch)
Definition string2.h:51
size_t dsize
Length of data.
Definition buffer.h:39
char * data
Pointer to data.
Definition buffer.h:37
const char * name
Name of the command.
Definition command.h:51
int match_list_len
Enough space for all of the config items.
Definition data.h:38
char user_typed[1024]
Initial string that starts completion.
Definition data.h:34
char completed[256]
Completed string (command or variable)
Definition data.h:36
int num_matched
Number of matches for completion.
Definition data.h:35
const char ** match_list
Matching strings.
Definition data.h:37
struct ConfigSet * cs
Parent ConfigSet.
Definition subset.h:50
The item stored in a Hash Table.
Definition hash.h:44
Mapping between a function and an operation.
Definition lib.h:115
const char * name
Name of the function.
Definition lib.h:116
Container for Accounts, Notifications.
Definition neomutt.h:43
struct CommandArray commands
NeoMutt commands.
Definition neomutt.h:51
struct ConfigSubset * sub
Inherited config items.
Definition neomutt.h:47
struct HashElemArray get_elem_list(struct ConfigSet *cs, enum GetElemListFlags flags)
Create a sorted list of all config items.
Definition subset.c:81
@ GEL_ALL_CONFIG
All the normal config (no synonyms or deprecated)
Definition subset.h:81
MenuType
Types of GUI selections.
Definition type.h:36
@ MENU_GENERIC
Generic selection list.
Definition type.h:46
@ MENU_PAGER
Pager pager (email viewer)
Definition type.h:48
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mutt_complete()

int mutt_complete ( struct CompletionData * cd,
struct Buffer * buf )

Attempt to complete a partial pathname.

Parameters
cdCompletion Data
bufBuffer containing pathname
Return values
0Ok
-1No matches

Given a partial pathname, fill in as much of the rest of the path as is unique.

Definition at line 57 of file complete.c.

58{
59 const char *p = NULL;
60 DIR *dir = NULL;
61 struct dirent *de = NULL;
62 int init = 0;
63 size_t len;
64 struct Buffer *dirpart = NULL;
65 struct Buffer *exp_dirpart = NULL;
66 struct Buffer *filepart = NULL;
67 struct Buffer *tmp = NULL;
68 struct Buffer *imap_path = NULL;
69 int rc;
70
71 mutt_debug(LL_DEBUG2, "completing %s\n", buf_string(buf));
72
73 if (OptNews)
74 return nntp_complete(buf);
75
76 const char *const c_spool_file = cs_subset_string(NeoMutt->sub, "spool_file");
77 const char *const c_folder = cs_subset_string(NeoMutt->sub, "folder");
78
79 imap_path = buf_pool_get();
80 /* we can use '/' as a delimiter, imap_complete rewrites it */
81 char ch = buf_at(buf, 0);
82 if ((ch == '=') || (ch == '+') || (ch == '!'))
83 {
84 if (ch == '!')
85 p = NONULL(c_spool_file);
86 else
87 p = NONULL(c_folder);
88
89 buf_concat_path(imap_path, p, buf_string(buf) + 1);
90 }
91 else
92 {
93 buf_copy(imap_path, buf);
94 }
95
96 if (imap_path_probe(buf_string(imap_path), NULL) == MUTT_IMAP)
97 {
98 rc = imap_complete(buf, buf_string(imap_path));
99 buf_pool_release(&imap_path);
100 return rc;
101 }
102
103 buf_pool_release(&imap_path);
104
105 dirpart = buf_pool_get();
106 exp_dirpart = buf_pool_get();
107 filepart = buf_pool_get();
108 tmp = buf_pool_get();
109
110 ch = buf_at(buf, 0);
111 if ((ch == '=') || (ch == '+') || (ch == '!'))
112 {
113 buf_addch(dirpart, ch);
114 if (ch == '!')
115 buf_strcpy(exp_dirpart, c_spool_file);
116 else
117 buf_strcpy(exp_dirpart, c_folder);
118 p = strrchr(buf_string(buf), '/');
119 if (p)
120 {
121 buf_concatn_path(tmp, buf_string(exp_dirpart), buf_len(exp_dirpart),
122 buf_string(buf) + 1, (size_t) (p - buf_string(buf) - 1));
123 buf_copy(exp_dirpart, tmp);
124 buf_substrcpy(dirpart, buf_string(buf), p + 1);
125 buf_strcpy(filepart, p + 1);
126 }
127 else
128 {
129 buf_strcpy(filepart, buf_string(buf) + 1);
130 }
132 }
133 else
134 {
135 p = strrchr(buf_string(buf), '/');
136 if (p)
137 {
138 if (p == buf_string(buf)) /* absolute path */
139 {
140 p = buf_string(buf) + 1;
141 buf_strcpy(dirpart, "/");
142 buf_strcpy(filepart, p);
144 }
145 else
146 {
147 buf_substrcpy(dirpart, buf_string(buf), p);
148 buf_strcpy(filepart, p + 1);
149 buf_copy(exp_dirpart, dirpart);
150 buf_expand_path(exp_dirpart);
152 }
153 }
154 else
155 {
156 /* no directory name, so assume current directory. */
157 buf_strcpy(filepart, buf_string(buf));
159 }
160 }
161
162 if (!dir)
163 {
164 mutt_debug(LL_DEBUG1, "%s: %s (errno %d)\n", buf_string(exp_dirpart),
165 strerror(errno), errno);
166 goto cleanup;
167 }
168
169 /* special case to handle when there is no filepart yet. find the first
170 * file/directory which is not "." or ".." */
171 len = buf_len(filepart);
172 if (len == 0)
173 {
174 while ((de = readdir(dir)))
175 {
176 if (!mutt_str_equal(".", de->d_name) && !mutt_str_equal("..", de->d_name))
177 {
178 buf_strcpy(filepart, de->d_name);
179 init++;
180 break;
181 }
182 }
183 }
184
185 while ((de = readdir(dir)))
186 {
187 if (mutt_strn_equal(de->d_name, buf_string(filepart), len))
188 {
189 if (init)
190 {
191 char *cp = filepart->data;
192
193 for (int i = 0; (*cp != '\0') && (de->d_name[i] != '\0'); i++, cp++)
194 {
195 if (*cp != de->d_name[i])
196 break;
197 }
198 *cp = '\0';
199 buf_fix_dptr(filepart);
200 }
201 else
202 {
203 struct stat st = { 0 };
204
205 buf_strcpy(filepart, de->d_name);
206
207 /* check to see if it is a directory */
208 if (buf_is_empty(dirpart))
209 {
210 buf_reset(tmp);
211 }
212 else
213 {
214 buf_copy(tmp, exp_dirpart);
215 buf_addch(tmp, '/');
216 }
217 buf_addstr(tmp, buf_string(filepart));
218 if ((stat(buf_string(tmp), &st) != -1) && (st.st_mode & S_IFDIR))
219 buf_addch(filepart, '/');
220 init = 1;
221 }
222 }
223 }
224 closedir(dir);
225
226 if (buf_is_empty(dirpart))
227 {
228 buf_copy(buf, filepart);
229 }
230 else
231 {
232 buf_copy(buf, dirpart);
233 if (!mutt_str_equal("/", buf_string(dirpart)) &&
234 (buf_string(dirpart)[0] != '=') && (buf_string(dirpart)[0] != '+'))
235 {
236 buf_addstr(buf, "/");
237 }
238 buf_addstr(buf, buf_string(filepart));
239 }
240
241cleanup:
242 buf_pool_release(&dirpart);
243 buf_pool_release(&exp_dirpart);
244 buf_pool_release(&filepart);
245 buf_pool_release(&tmp);
246
247 return init ? 0 : -1;
248}
size_t buf_len(const struct Buffer *buf)
Calculate the length of a Buffer.
Definition buffer.c:491
void buf_reset(struct Buffer *buf)
Reset an existing Buffer.
Definition buffer.c:76
bool buf_is_empty(const struct Buffer *buf)
Is the Buffer empty?
Definition buffer.c:291
char buf_at(const struct Buffer *buf, size_t offset)
Return the character at the given offset.
Definition buffer.c:668
size_t buf_concatn_path(struct Buffer *buf, const char *dir, size_t dirlen, const char *fname, size_t fnamelen)
Join a directory name and a filename.
Definition buffer.c:546
size_t buf_addch(struct Buffer *buf, char c)
Add a single character to a Buffer.
Definition buffer.c:241
size_t buf_addstr(struct Buffer *buf, const char *s)
Add a string to a Buffer.
Definition buffer.c:226
size_t buf_copy(struct Buffer *dst, const struct Buffer *src)
Copy a Buffer's contents to another Buffer.
Definition buffer.c:601
size_t buf_concat_path(struct Buffer *buf, const char *dir, const char *fname)
Join a directory name and a filename.
Definition buffer.c:509
size_t buf_substrcpy(struct Buffer *buf, const char *beg, const char *end)
Copy a partial string into a Buffer.
Definition buffer.c:471
static const char * buf_string(const struct Buffer *buf)
Convert a buffer to a const char * "string".
Definition buffer.h:96
const char * cs_subset_string(const struct ConfigSubset *sub, const char *name)
Get a string config item by name.
Definition helpers.c:291
@ MUTT_IMAP
'IMAP' Mailbox type
Definition mailbox.h:50
DIR * mutt_file_opendir(const char *path, enum MuttOpenDirMode mode)
Open a directory.
Definition file.c:542
@ MUTT_OPENDIR_NONE
Plain opendir()
Definition file.h:63
bool OptNews
(pseudo) used to change reader mode
Definition globals.c:64
#define mutt_debug(LEVEL,...)
Definition logging2.h:90
enum MailboxType imap_path_probe(const char *path, const struct stat *st)
Is this an IMAP Mailbox?
Definition imap.c:2349
int imap_complete(struct Buffer *buf, const char *path)
Try to complete an IMAP folder path.
Definition imap.c:1277
@ LL_DEBUG2
Log at debug level 2.
Definition logging2.h:45
@ LL_DEBUG1
Log at debug level 1.
Definition logging2.h:44
bool mutt_str_equal(const char *a, const char *b)
Compare two strings.
Definition string.c:660
bool mutt_strn_equal(const char *a, const char *b, size_t num)
Check for equality of two strings (to a maximum), safely.
Definition string.c:427
void buf_expand_path(struct Buffer *buf)
Create the canonical path.
Definition muttlib.c:314
int nntp_complete(struct Buffer *buf)
Auto-complete NNTP newsgroups.
Definition complete.c:46
struct Buffer * buf_pool_get(void)
Get a Buffer from the pool.
Definition pool.c:82
void buf_pool_release(struct Buffer **ptr)
Return a Buffer to the pool.
Definition pool.c:96
#define NONULL(x)
Definition string2.h:43
String manipulation buffer.
Definition buffer.h:36
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mutt_label_complete()

int mutt_label_complete ( struct CompletionData * cd,
struct Buffer * buf,
int numtabs )

Complete a label name.

Parameters
cdCompletion Data
bufBuffer for the result
numtabsNumber of times the user has hit 'tab'
Return values
1Success, a match
0Error, no match

Definition at line 310 of file helpers.c.

311{
312 char *pt = buf->data;
313
314 struct Mailbox *m_cur = get_current_mailbox();
315 if (!m_cur || !m_cur->label_hash)
316 return 0;
317
318 SKIPWS(pt);
319
320 /* first TAB. Collect all the matches */
321 if (numtabs == 1)
322 {
323 struct HashElem *he = NULL;
324 struct HashWalkState hws = { 0 };
325
326 cd->num_matched = 0;
327 mutt_str_copy(cd->user_typed, buf_string(buf), sizeof(cd->user_typed));
328 memset(cd->match_list, 0, cd->match_list_len);
329 memset(cd->completed, 0, sizeof(cd->completed));
330 while ((he = mutt_hash_walk(m_cur->label_hash, &hws)))
331 candidate(cd, cd->user_typed, he->key.strkey, cd->completed, sizeof(cd->completed));
333 mutt_qsort_r(cd->match_list, cd->num_matched, sizeof(char *), label_sort, NULL);
334 cd->match_list[cd->num_matched++] = cd->user_typed;
335
336 /* All matches are stored. Longest non-ambiguous string is ""
337 * i.e. don't change 'buf'. Fake successful return this time */
338 if (cd->user_typed[0] == '\0')
339 return 1;
340 }
341
342 if ((cd->completed[0] == '\0') && (cd->user_typed[0] != '\0'))
343 return 0;
344
345 /* cd->num_matched will _always_ be at least 1 since the initial
346 * user-typed string is always stored */
347 if ((numtabs == 1) && (cd->num_matched == 2))
348 {
349 snprintf(cd->completed, sizeof(cd->completed), "%s", cd->match_list[0]);
350 }
351 else if ((numtabs > 1) && (cd->num_matched > 2))
352 {
353 /* cycle through all the matches */
354 snprintf(cd->completed, sizeof(cd->completed), "%s",
355 cd->match_list[(numtabs - 2) % cd->num_matched]);
356 }
357
358 /* return the completed label */
359 buf_strcpy(buf, cd->completed);
360
361 return 1;
362}
static int label_sort(const void *a, const void *b, void *sdata)
Compare two label strings - Implements sort_t -.
Definition helpers.c:297
struct HashElem * mutt_hash_walk(const struct HashTable *table, struct HashWalkState *state)
Iterate through all the HashElem's in a Hash Table.
Definition hash.c:489
struct Mailbox * get_current_mailbox(void)
Get the current Mailbox.
Definition index.c:721
void mutt_qsort_r(void *base, size_t nmemb, size_t size, sort_t compar, void *sdata)
Sort an array, where the comparator has access to opaque data rather than requiring global variables.
Definition qsort_r.c:67
union HashKey key
Key representing the data.
Definition hash.h:46
Cursor to iterate through a Hash Table.
Definition hash.h:134
A mailbox.
Definition mailbox.h:79
struct HashTable * label_hash
Hash Table: "x-labels" -> Email.
Definition mailbox.h:125
const char * strkey
String key.
Definition hash.h:36
+ 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
cdCompletion Data
bufBuffer for the result
numtabsNumber of times the user has hit 'tab'
Return values
trueSuccess, a match
falseError, no match

Complete the last "tag:"-prefixed string.

Definition at line 101 of file complete.c.

102{
103 char *pt = buf->data;
104 int spaces;
105
106 SKIPWS(pt);
107 spaces = pt - buf->data;
108
109 pt = (char *) buf_rfind(buf, "tag:");
110 if (pt)
111 {
112 pt += 4;
113 if (numtabs == 1)
114 {
115 /* First TAB. Collect all the matches */
116 complete_all_nm_tags(cd, pt);
117
118 /* All matches are stored. Longest non-ambiguous string is ""
119 * i.e. don't change 'buf'. Fake successful return this time. */
120 if (cd->user_typed[0] == '\0')
121 return true;
122 }
123
124 if ((cd->completed[0] == '\0') && (cd->user_typed[0] != '\0'))
125 return false;
126
127 /* cd->num_matched will _always_ be at least 1 since the initial
128 * user-typed string is always stored */
129 if ((numtabs == 1) && (cd->num_matched == 2))
130 {
131 snprintf(cd->completed, sizeof(cd->completed), "%s", cd->match_list[0]);
132 }
133 else if ((numtabs > 1) && (cd->num_matched > 2))
134 {
135 /* cycle through all the matches */
136 snprintf(cd->completed, sizeof(cd->completed), "%s",
137 cd->match_list[(numtabs - 2) % cd->num_matched]);
138 }
139
140 /* return the completed query */
141 strncpy(pt, cd->completed, buf->data + buf->dsize - pt - spaces);
142 }
143 else
144 {
145 return false;
146 }
147
148 return true;
149}
const char * buf_rfind(const struct Buffer *buf, const char *str)
Find last instance of a substring.
Definition buffer.c:795
int complete_all_nm_tags(struct CompletionData *cd, const char *pt)
Pass a list of Notmuch tags to the completion code.
Definition complete.c:48
+ 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
cdCompletion Data
bufBuffer for the result
numtabsNumber of times the user has hit 'tab'
Return values
trueSuccess, a match
falseError, no match

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

Definition at line 161 of file complete.c.

162{
163 if (!buf)
164 return false;
165
166 char *pt = buf->data;
167
168 /* Only examine the last token */
169 char *last_space = strrchr(buf->data, ' ');
170 if (last_space)
171 pt = (last_space + 1);
172
173 /* Skip the +/- */
174 if ((pt[0] == '+') || (pt[0] == '-'))
175 pt++;
176
177 if (numtabs == 1)
178 {
179 /* First TAB. Collect all the matches */
180 complete_all_nm_tags(cd, pt);
181
182 /* All matches are stored. Longest non-ambiguous string is ""
183 * i.e. don't change 'buf'. Fake successful return this time. */
184 if (cd->user_typed[0] == '\0')
185 return true;
186 }
187
188 if ((cd->completed[0] == '\0') && (cd->user_typed[0] != '\0'))
189 return false;
190
191 /* cd->num_matched will _always_ be at least 1 since the initial
192 * user-typed string is always stored */
193 if ((numtabs == 1) && (cd->num_matched == 2))
194 {
195 snprintf(cd->completed, sizeof(cd->completed), "%s", cd->match_list[0]);
196 }
197 else if ((numtabs > 1) && (cd->num_matched > 2))
198 {
199 /* cycle through all the matches */
200 snprintf(cd->completed, sizeof(cd->completed), "%s",
201 cd->match_list[(numtabs - 2) % cd->num_matched]);
202 }
203
204 /* return the completed query */
205 strncpy(pt, cd->completed, buf->data + buf->dsize - pt);
206
207 return true;
208}
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mutt_var_value_complete()

int mutt_var_value_complete ( struct CompletionData * cd,
struct Buffer * buf,
int pos )

Complete a variable/value.

Parameters
cdCompletion Data
bufBuffer for the result
posCursor position in the buffer
Return values
1Success
0Failure

Definition at line 372 of file helpers.c.

373{
374 char *pt = buf->data;
375
376 if (pt[0] == '\0')
377 return 0;
378
379 SKIPWS(pt);
380 const int spaces = pt - buf->data;
381
382 pt = buf->data + pos - spaces;
383 while ((pt > buf->data) && !mutt_isspace(*pt))
384 pt--;
385 pt++; /* move past the space */
386 if (*pt == '=') /* abort if no var before the '=' */
387 return 0;
388
389 if (buf_startswith(buf, "set"))
390 {
391 char var[256] = { 0 };
392 mutt_str_copy(var, pt, sizeof(var));
393 /* ignore the trailing '=' when comparing */
394 int vlen = mutt_str_len(var);
395 if (vlen == 0)
396 return 0;
397
398 var[vlen - 1] = '\0';
399
400 struct HashElem *he = cs_subset_lookup(NeoMutt->sub, var);
401 if (!he)
402 return 0; /* no such variable. */
403
404 struct Buffer *value = buf_pool_get();
405 struct Buffer *pretty = buf_pool_get();
406 int rc = cs_subset_he_string_get(NeoMutt->sub, he, value);
407 if (CSR_RESULT(rc) == CSR_SUCCESS)
408 {
409 pretty_var(value->data, pretty);
410 snprintf(pt, buf->dsize - (pt - buf->data), "%s=%s", var, pretty->data);
411 buf_pool_release(&value);
412 buf_pool_release(&pretty);
413 return 0;
414 }
415 buf_pool_release(&value);
416 buf_pool_release(&pretty);
417 return 1;
418 }
419 return 0;
420}
size_t pretty_var(const char *str, struct Buffer *buf)
Escape and stringify a config item value.
Definition dump.c:85
#define CSR_RESULT(x)
Definition set.h:50
#define CSR_SUCCESS
Action completed successfully.
Definition set.h:33
int cs_subset_he_string_get(const struct ConfigSubset *sub, struct HashElem *he, struct Buffer *result)
Get a config item as a string.
Definition subset.c:338
struct HashElem * cs_subset_lookup(const struct ConfigSubset *sub, const char *name)
Find an inherited config item.
Definition subset.c:193
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ matches_ensure_morespace()

void matches_ensure_morespace ( struct CompletionData * cd,
int new_size )

Allocate more space for auto-completion.

Parameters
cdCompletion Data
new_sizeSpace required

Definition at line 53 of file helpers.c.

54{
55 if (new_size <= (cd->match_list_len - 2))
56 return;
57
58 new_size = ROUND_UP(new_size + 2, 512);
59
60 MUTT_MEM_REALLOC(&cd->match_list, new_size, const char *);
61 memset(&cd->match_list[cd->match_list_len], 0, new_size - cd->match_list_len);
62
63 cd->match_list_len = new_size;
64}
#define ROUND_UP(NUM, STEP)
Definition memory.h:41
#define MUTT_MEM_REALLOC(pptr, n, type)
Definition memory.h:50
+ Here is the caller graph for this function:

◆ candidate()

bool candidate ( struct CompletionData * cd,
char * user,
const char * src,
char * dest,
size_t dlen )

Helper function for completion.

Parameters
cdCompletion Data
userUser entered data for completion
srcCandidate for completion
destCompletion result gets here
dlenLength of dest buffer
Return values
trueIf candidate string matches

Changes the dest buffer if necessary/possible to aid completion.

Definition at line 77 of file helpers.c.

78{
79 if (!dest || !user || !src)
80 return false;
81
82 if (strstr(src, user) != src)
83 return false;
84
86 cd->match_list[cd->num_matched++] = src;
87 if (dest[0] == '\0')
88 {
89 mutt_str_copy(dest, src, dlen);
90 }
91 else
92 {
93 int l;
94 for (l = 0; (src[l] != '\0') && (src[l] == dest[l]); l++)
95 ; // do nothing
96
97 dest[l] = '\0';
98 }
99 return true;
100}
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

Variable Documentation

◆ CompleteCommandOps

const struct CompleteOps CompleteCommandOps
extern

Auto-Completion of Commands.

Definition at line 476 of file helpers.c.

476 {
477 .complete = complete_command,
478};
enum FunctionRetval complete_command(struct EnterWindowData *wdata, int op)
Complete a NeoMutt Command - Implements CompleteOps::complete() -.
Definition helpers.c:425

◆ CompleteLabelOps

const struct CompleteOps CompleteLabelOps
extern

Auto-Completion of Labels.

Definition at line 483 of file helpers.c.

483 {
484 .complete = complete_label,
485};
enum FunctionRetval complete_label(struct EnterWindowData *wdata, int op)
Complete a label - Implements CompleteOps::complete() -.
Definition helpers.c:450