NeoMutt  2025-09-05-70-gcfdde0
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, void *cdata)
 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,
void * cdata )

Complete a command name.

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

Definition at line 112 of file helpers.c.

114{
115 char *pt = buf->data;
116 int spaces; /* keep track of the number of leading spaces on the line */
117
118 SKIPWS(pt);
119 spaces = pt - buf->data;
120
121 pt = buf->data + pos - spaces;
122 while ((pt > buf->data) && !mutt_isspace(*pt))
123 pt--;
124
125 if (pt == buf->data) /* complete cmd */
126 {
127 /* first TAB. Collect all the matches */
128 if (numtabs == 1)
129 {
130 cd->num_matched = 0;
131 mutt_str_copy(cd->user_typed, pt, sizeof(cd->user_typed));
132 memset(cd->match_list, 0, cd->match_list_len);
133 memset(cd->completed, 0, sizeof(cd->completed));
134
135 const struct Command **cp = NULL;
137 {
138 const struct Command *cmd = *cp;
139
140 candidate(cd, cd->user_typed, cmd->name, cd->completed, sizeof(cd->completed));
141 }
142
144 cd->match_list[cd->num_matched++] = cd->user_typed;
145
146 /* All matches are stored. Longest non-ambiguous string is ""
147 * i.e. don't change 'buf'. Fake successful return this time */
148 if (cd->user_typed[0] == '\0')
149 return 1;
150 }
151
152 if ((cd->completed[0] == '\0') && (cd->user_typed[0] != '\0'))
153 return 0;
154
155 /* cd->num_matched will _always_ be at least 1 since the initial
156 * user-typed string is always stored */
157 if ((numtabs == 1) && (cd->num_matched == 2))
158 {
159 snprintf(cd->completed, sizeof(cd->completed), "%s", cd->match_list[0]);
160 }
161 else if ((numtabs > 1) && (cd->num_matched > 2))
162 {
163 /* cycle through all the matches */
164 snprintf(cd->completed, sizeof(cd->completed), "%s",
165 cd->match_list[(numtabs - 2) % cd->num_matched]);
166 }
167
168 /* return the completed command */
169 buf_strcpy(buf, cd->completed);
170 }
171 else if (buf_startswith(buf, "set") || buf_startswith(buf, "unset") ||
172 buf_startswith(buf, "reset") || buf_startswith(buf, "toggle"))
173 { /* complete variables */
174 static const char *const prefixes[] = { "no", "inv", "?", "&", 0 };
175
176 pt++;
177 /* loop through all the possible prefixes (no, inv, ...) */
178 if (buf_startswith(buf, "set"))
179 {
180 for (int num = 0; prefixes[num]; num++)
181 {
182 if (mutt_str_startswith(pt, prefixes[num]))
183 {
184 pt += mutt_str_len(prefixes[num]);
185 break;
186 }
187 }
188 }
189
190 /* first TAB. Collect all the matches */
191 if (numtabs == 1)
192 {
193 cd->num_matched = 0;
194 mutt_str_copy(cd->user_typed, pt, sizeof(cd->user_typed));
195 memset(cd->match_list, 0, cd->match_list_len);
196 memset(cd->completed, 0, sizeof(cd->completed));
197
198 struct HashElemArray hea = get_elem_list(NeoMutt->sub->cs, GEL_ALL_CONFIG);
199 struct HashElem **hep = NULL;
200 ARRAY_FOREACH(hep, &hea)
201 {
202 candidate(cd, cd->user_typed, (*hep)->key.strkey, cd->completed,
203 sizeof(cd->completed));
204 }
205 ARRAY_FREE(&hea);
206
208 cd->match_list[cd->num_matched++] = cd->user_typed;
209
210 /* All matches are stored. Longest non-ambiguous string is ""
211 * i.e. don't change 'buf'. Fake successful return this time */
212 if (cd->user_typed[0] == '\0')
213 return 1;
214 }
215
216 if ((cd->completed[0] == 0) && cd->user_typed[0])
217 return 0;
218
219 /* cd->num_matched will _always_ be at least 1 since the initial
220 * user-typed string is always stored */
221 if ((numtabs == 1) && (cd->num_matched == 2))
222 {
223 snprintf(cd->completed, sizeof(cd->completed), "%s", cd->match_list[0]);
224 }
225 else if ((numtabs > 1) && (cd->num_matched > 2))
226 {
227 /* cycle through all the matches */
228 snprintf(cd->completed, sizeof(cd->completed), "%s",
229 cd->match_list[(numtabs - 2) % cd->num_matched]);
230 }
231
232 strncpy(pt, cd->completed, buf->data + buf->dsize - pt - spaces);
233 buf_fix_dptr(buf);
234 }
235 else if (buf_startswith(buf, "exec"))
236 {
237 enum MenuType mtype = MENU_GENERIC;
238 if (cdata)
239 {
240 struct FileCompletionData *fcd = cdata;
241 struct MuttWindow *win = fcd->win;
242 if (win && win->wdata)
243 {
244 struct Menu *menu = win->wdata;
245 mtype = menu->type;
246 }
247 }
248 else
249 {
250 mtype = menu_get_current_type();
251 }
252 const struct MenuFuncOp *funcs = km_get_table(mtype);
253 if (!funcs && (mtype != MENU_PAGER))
254 funcs = OpGeneric;
255
256 pt++;
257 /* first TAB. Collect all the matches */
258 if (numtabs == 1)
259 {
260 cd->num_matched = 0;
261 mutt_str_copy(cd->user_typed, pt, sizeof(cd->user_typed));
262 memset(cd->match_list, 0, cd->match_list_len);
263 memset(cd->completed, 0, sizeof(cd->completed));
264 for (int num = 0; funcs[num].name; num++)
265 candidate(cd, cd->user_typed, funcs[num].name, cd->completed, sizeof(cd->completed));
266 /* try the generic menu */
267 if ((mtype != MENU_PAGER) && (mtype != MENU_GENERIC))
268 {
269 funcs = OpGeneric;
270 for (int num = 0; funcs[num].name; num++)
271 candidate(cd, cd->user_typed, funcs[num].name, cd->completed,
272 sizeof(cd->completed));
273 }
275 cd->match_list[cd->num_matched++] = cd->user_typed;
276
277 /* All matches are stored. Longest non-ambiguous string is ""
278 * i.e. don't change 'buf'. Fake successful return this time */
279 if (cd->user_typed[0] == '\0')
280 return 1;
281 }
282
283 if ((cd->completed[0] == '\0') && (cd->user_typed[0] != '\0'))
284 return 0;
285
286 /* cd->num_matched will _always_ be at least 1 since the initial
287 * user-typed string is always stored */
288 if ((numtabs == 1) && (cd->num_matched == 2))
289 {
290 snprintf(cd->completed, sizeof(cd->completed), "%s", cd->match_list[0]);
291 }
292 else if ((numtabs > 1) && (cd->num_matched > 2))
293 {
294 /* cycle through all the matches */
295 snprintf(cd->completed, sizeof(cd->completed), "%s",
296 cd->match_list[(numtabs - 2) % cd->num_matched]);
297 }
298
299 strncpy(pt, cd->completed, buf->data + buf->dsize - pt - spaces);
300 buf_fix_dptr(buf);
301 }
302 else
303 {
304 return 0;
305 }
306
307 return 1;
308}
#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:482
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
Input for the file completion function.
Definition curs_lib.h:39
struct MuttWindow * win
Current Focused Window.
Definition curs_lib.h:44
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
Definition lib.h:79
struct MuttWindow * win
Window holding the Menu.
Definition lib.h:86
enum MenuType type
Menu definition for keymap entries.
Definition lib.h:83
void * wdata
Private data.
Container for Accounts, Notifications.
Definition neomutt.h:42
struct CommandArray commands
NeoMutt commands.
Definition neomutt.h:50
struct ConfigSubset * sub
Inherited config items.
Definition neomutt.h:46
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:35
@ MENU_GENERIC
Generic selection list.
Definition type.h:45
@ MENU_PAGER
Pager pager (email viewer)
Definition type.h:47
+ 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:2351
int imap_complete(struct Buffer *buf, const char *path)
Try to complete an IMAP folder path.
Definition imap.c:1279
@ 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 326 of file helpers.c.

327{
328 char *pt = buf->data;
329
330 struct Mailbox *m_cur = get_current_mailbox();
331 if (!m_cur || !m_cur->label_hash)
332 return 0;
333
334 SKIPWS(pt);
335
336 /* first TAB. Collect all the matches */
337 if (numtabs == 1)
338 {
339 struct HashElem *he = NULL;
340 struct HashWalkState hws = { 0 };
341
342 cd->num_matched = 0;
343 mutt_str_copy(cd->user_typed, buf_string(buf), sizeof(cd->user_typed));
344 memset(cd->match_list, 0, cd->match_list_len);
345 memset(cd->completed, 0, sizeof(cd->completed));
346 while ((he = mutt_hash_walk(m_cur->label_hash, &hws)))
347 candidate(cd, cd->user_typed, he->key.strkey, cd->completed, sizeof(cd->completed));
349 mutt_qsort_r(cd->match_list, cd->num_matched, sizeof(char *), label_sort, NULL);
350 cd->match_list[cd->num_matched++] = cd->user_typed;
351
352 /* All matches are stored. Longest non-ambiguous string is ""
353 * i.e. don't change 'buf'. Fake successful return this time */
354 if (cd->user_typed[0] == '\0')
355 return 1;
356 }
357
358 if ((cd->completed[0] == '\0') && (cd->user_typed[0] != '\0'))
359 return 0;
360
361 /* cd->num_matched will _always_ be at least 1 since the initial
362 * user-typed string is always stored */
363 if ((numtabs == 1) && (cd->num_matched == 2))
364 {
365 snprintf(cd->completed, sizeof(cd->completed), "%s", cd->match_list[0]);
366 }
367 else if ((numtabs > 1) && (cd->num_matched > 2))
368 {
369 /* cycle through all the matches */
370 snprintf(cd->completed, sizeof(cd->completed), "%s",
371 cd->match_list[(numtabs - 2) % cd->num_matched]);
372 }
373
374 /* return the completed label */
375 buf_strcpy(buf, cd->completed);
376
377 return 1;
378}
static int label_sort(const void *a, const void *b, void *sdata)
Compare two label strings - Implements sort_t -.
Definition helpers.c:313
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 388 of file helpers.c.

389{
390 char *pt = buf->data;
391
392 if (pt[0] == '\0')
393 return 0;
394
395 SKIPWS(pt);
396 const int spaces = pt - buf->data;
397
398 pt = buf->data + pos - spaces;
399 while ((pt > buf->data) && !mutt_isspace(*pt))
400 pt--;
401 pt++; /* move past the space */
402 if (*pt == '=') /* abort if no var before the '=' */
403 return 0;
404
405 if (buf_startswith(buf, "set"))
406 {
407 char var[256] = { 0 };
408 mutt_str_copy(var, pt, sizeof(var));
409 /* ignore the trailing '=' when comparing */
410 int vlen = mutt_str_len(var);
411 if (vlen == 0)
412 return 0;
413
414 var[vlen - 1] = '\0';
415
416 struct HashElem *he = cs_subset_lookup(NeoMutt->sub, var);
417 if (!he)
418 return 0; /* no such variable. */
419
420 struct Buffer *value = buf_pool_get();
421 struct Buffer *pretty = buf_pool_get();
422 int rc = cs_subset_he_string_get(NeoMutt->sub, he, value);
423 if (CSR_RESULT(rc) == CSR_SUCCESS)
424 {
425 pretty_var(value->data, pretty);
426 snprintf(pt, buf->dsize - (pt - buf->data), "%s=%s", var, pretty->data);
427 buf_pool_release(&value);
428 buf_pool_release(&pretty);
429 return 0;
430 }
431 buf_pool_release(&value);
432 buf_pool_release(&pretty);
433 return 1;
434 }
435 return 0;
436}
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 492 of file helpers.c.

492 {
493 .complete = complete_command,
494};
enum FunctionRetval complete_command(struct EnterWindowData *wdata, int op)
Complete a NeoMutt Command - Implements CompleteOps::complete() -.
Definition helpers.c:441

◆ CompleteLabelOps

const struct CompleteOps CompleteLabelOps
extern

Auto-Completion of Labels.

Definition at line 499 of file helpers.c.

499 {
500 .complete = complete_label,
501};
enum FunctionRetval complete_label(struct EnterWindowData *wdata, int op)
Complete a label - Implements CompleteOps::complete() -.
Definition helpers.c:466