NeoMutt  2025-12-11-694-ga89709
Teaching an old dog new tricks
 		DOXYGEN
Loading...
Searching...
No Matches
Functions
complete.c File Reference

String auto-completion routines. More...

#include "config.h"
#include <dirent.h>
#include <errno.h>
#include <stdbool.h>
#include <string.h>
#include <sys/stat.h>
#include "mutt/lib.h"
#include "config/lib.h"
#include "core/lib.h"
#include "lib.h"
#include "imap/lib.h"
#include "nntp/lib.h"
#include "globals.h"
#include "muttlib.h"
+ Include dependency graph for complete.c:

Go to the source code of this file.

Functions

int mutt_complete (struct CompletionData *cd, struct Buffer *buf)
 Attempt to complete a partial pathname.
 

Detailed Description

String auto-completion routines.

Authors
  • Richard Russon
  • Pietro Cerutti
  • Anna Figueiredo Gomes
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

◆ 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 58 of file complete.c.

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