NeoMutt  2024-03-23-23-gec7045
Teaching an old dog new tricks
DOXYGEN
Loading...
Searching...
No Matches
commands.h File Reference

Functions to parse commands in a config file. More...

#include "config.h"
#include <stdint.h>
#include "config/lib.h"
#include "core/lib.h"
+ Include dependency graph for commands.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros

#define MUTT_NAMED   (1 << 0)
 

Functions

enum CommandResult parse_mailboxes (struct Buffer *buf, struct Buffer *s, intptr_t data, struct Buffer *err)
 Parse the 'mailboxes' command - Implements Command::parse() -.
 
enum CommandResult parse_my_hdr (struct Buffer *buf, struct Buffer *s, intptr_t data, struct Buffer *err)
 Parse the 'my_hdr' command - Implements Command::parse() -.
 
enum CommandResult parse_subjectrx_list (struct Buffer *buf, struct Buffer *s, intptr_t data, struct Buffer *err)
 Parse the 'subjectrx' command - Implements Command::parse() -.
 
enum CommandResult parse_subscribe_to (struct Buffer *buf, struct Buffer *s, intptr_t data, struct Buffer *err)
 Parse the 'subscribe-to' command - Implements Command::parse() -.
 
enum CommandResult parse_unalternates (struct Buffer *buf, struct Buffer *s, intptr_t data, struct Buffer *err)
 Parse the 'unalternates' command - Implements Command::parse() -.
 
enum CommandResult parse_unmailboxes (struct Buffer *buf, struct Buffer *s, intptr_t data, struct Buffer *err)
 Parse the 'unmailboxes' command - Implements Command::parse() -.
 
enum CommandResult parse_unsubjectrx_list (struct Buffer *buf, struct Buffer *s, intptr_t data, struct Buffer *err)
 Parse the 'unsubjectrx' command - Implements Command::parse() -.
 
enum CommandResult parse_unsubscribe_from (struct Buffer *buf, struct Buffer *s, intptr_t data, struct Buffer *err)
 Parse the 'unsubscribe-from' command - Implements Command::parse() -.
 
enum CommandResult parse_rc_line_cwd (const char *line, char *cwd, struct Buffer *err)
 Parse and run a muttrc line in a relative directory.
 
char * mutt_get_sourced_cwd (void)
 Get the current file path that is being parsed.
 
int parse_grouplist (struct GroupList *gl, struct Buffer *buf, struct Buffer *s, struct Buffer *err)
 Parse a group context.
 
void source_stack_cleanup (void)
 Free memory from the stack used for the source command.
 
int source_rc (const char *rcfile_path, struct Buffer *err)
 Read an initialization file.
 
enum CommandResult set_dump (ConfigDumpFlags flags, struct Buffer *err)
 Dump list of config variables into a file/pager.
 

Detailed Description

Functions to parse commands in a config file.

Authors
  • Richard Russon

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

Macro Definition Documentation

◆ MUTT_NAMED

#define MUTT_NAMED   (1 << 0)

Definition at line 35 of file commands.h.

Function Documentation

◆ parse_rc_line_cwd()

enum CommandResult parse_rc_line_cwd ( const char *  line,
char *  cwd,
struct Buffer err 
)

Parse and run a muttrc line in a relative directory.

Parameters
lineLine to be parsed
cwdFile relative where to run the line
errWhere to write error messages
Return values
CommandResultResult e.g. MUTT_CMD_SUCCESS

Definition at line 164 of file commands.c.

165{
167
168 enum CommandResult ret = parse_rc_line(line, err);
169
170 struct ListNode *np = STAILQ_FIRST(&MuttrcStack);
172 FREE(&np->data);
173 FREE(&np);
174
175 return ret;
176}
CommandResult
Error codes for command_t parse functions.
Definition: command.h:36
static struct ListHead MuttrcStack
LIFO designed to contain the list of config files that have been sourced and avoid cyclic sourcing.
Definition: commands.c:76
struct ListNode * mutt_list_insert_head(struct ListHead *h, char *s)
Insert a string at the beginning of a List.
Definition: list.c:45
#define FREE(x)
Definition: memory.h:45
char * mutt_str_dup(const char *str)
Copy a string, safely.
Definition: string.c:253
#define STAILQ_REMOVE_HEAD(head, field)
Definition: queue.h:422
#define STAILQ_FIRST(head)
Definition: queue.h:350
enum CommandResult parse_rc_line(const char *line, struct Buffer *err)
Parse a line of user config.
Definition: rc.c:104
#define NONULL(x)
Definition: string2.h:37
A List node for strings.
Definition: list.h:35
char * data
String.
Definition: list.h:36
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mutt_get_sourced_cwd()

char * mutt_get_sourced_cwd ( void  )

Get the current file path that is being parsed.

Return values
ptrFile path that is being parsed or cwd at runtime
Note
Caller is responsible for freeing returned string

Definition at line 184 of file commands.c.

185{
186 struct ListNode *np = STAILQ_FIRST(&MuttrcStack);
187 if (np && np->data)
188 return mutt_str_dup(np->data);
189
190 // stack is empty, return our own dummy file relative to cwd
191 struct Buffer *cwd = buf_pool_get();
192 mutt_path_getcwd(cwd);
193 buf_addstr(cwd, "/dummy.rc");
194 char *ret = buf_strdup(cwd);
195 buf_pool_release(&cwd);
196 return ret;
197}
size_t buf_addstr(struct Buffer *buf, const char *s)
Add a string to a Buffer.
Definition: buffer.c:243
char * buf_strdup(const struct Buffer *buf)
Copy a Buffer's string.
Definition: buffer.c:588
const char * mutt_path_getcwd(struct Buffer *cwd)
Get the current working directory.
Definition: path.c:472
struct Buffer * buf_pool_get(void)
Get a Buffer from the pool.
Definition: pool.c:81
void buf_pool_release(struct Buffer **ptr)
Return a Buffer to the pool.
Definition: pool.c:94
String manipulation buffer.
Definition: buffer.h:36
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ parse_grouplist()

int parse_grouplist ( struct GroupList *  gl,
struct Buffer buf,
struct Buffer s,
struct Buffer err 
)

Parse a group context.

Parameters
glGroupList to add to
bufTemporary Buffer space
sBuffer containing string to be parsed
errBuffer for error messages
Return values
0Success
-1Error

Definition at line 130 of file commands.c.

132{
133 while (mutt_istr_equal(buf->data, "-group"))
134 {
135 if (!MoreArgs(s))
136 {
137 buf_strcpy(err, _("-group: no group name"));
138 return -1;
139 }
140
142
144
145 if (!MoreArgs(s))
146 {
147 buf_strcpy(err, _("out of arguments"));
148 return -1;
149 }
150
152 }
153
154 return 0;
155}
size_t buf_strcpy(struct Buffer *buf, const char *s)
Copy a string into a Buffer.
Definition: buffer.c:412
int parse_extract_token(struct Buffer *dest, struct Buffer *tok, TokenFlags flags)
Extract one token from a string.
Definition: extract.c:50
#define MoreArgs(buf)
Definition: extract.h:32
#define TOKEN_NO_FLAGS
No flags are set.
Definition: extract.h:46
void mutt_grouplist_add(struct GroupList *gl, struct Group *group)
Add a Group to a GroupList.
Definition: group.c:183
struct Group * mutt_pattern_group(const char *pat)
Match a pattern to a Group.
Definition: group.c:118
#define _(a)
Definition: message.h:28
bool mutt_istr_equal(const char *a, const char *b)
Compare two strings, ignoring case.
Definition: string.c:721
char * data
Pointer to data.
Definition: buffer.h:37
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ source_stack_cleanup()

void source_stack_cleanup ( void  )

Free memory from the stack used for the source command.

Definition at line 1627 of file commands.c.

1628{
1630}
void mutt_list_free(struct ListHead *h)
Free a List AND its strings.
Definition: list.c:122
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ source_rc()

int source_rc ( const char *  rcfile_path,
struct Buffer err 
)

Read an initialization file.

Parameters
rcfile_pathPath to initialization file
errBuffer for error messages
Return values
<0NeoMutt should pause to let the user know

Definition at line 205 of file commands.c.

206{
207 int lineno = 0, rc = 0, warnings = 0;
208 enum CommandResult line_rc;
209 struct Buffer *token = NULL, *linebuf = NULL;
210 char *line = NULL;
211 char *currentline = NULL;
212 char rcfile[PATH_MAX] = { 0 };
213 size_t linelen = 0;
214 pid_t pid;
215
216 mutt_str_copy(rcfile, rcfile_path, sizeof(rcfile));
217
218 size_t rcfilelen = mutt_str_len(rcfile);
219 if (rcfilelen == 0)
220 return -1;
221
222 bool ispipe = rcfile[rcfilelen - 1] == '|';
223
224 if (!ispipe)
225 {
226 struct ListNode *np = STAILQ_FIRST(&MuttrcStack);
227 if (!mutt_path_to_absolute(rcfile, np ? NONULL(np->data) : ""))
228 {
229 mutt_error(_("Error: Can't build path of '%s'"), rcfile_path);
230 return -1;
231 }
232
233 STAILQ_FOREACH(np, &MuttrcStack, entries)
234 {
235 if (mutt_str_equal(np->data, rcfile))
236 {
237 break;
238 }
239 }
240 if (np)
241 {
242 mutt_error(_("Error: Cyclic sourcing of configuration file '%s'"), rcfile);
243 return -1;
244 }
245
247 }
248
249 mutt_debug(LL_DEBUG2, "Reading configuration file '%s'\n", rcfile);
250
251 FILE *fp = mutt_open_read(rcfile, &pid);
252 if (!fp)
253 {
254 buf_printf(err, "%s: %s", rcfile, strerror(errno));
255 return -1;
256 }
257
258 token = buf_pool_get();
259 linebuf = buf_pool_get();
260
261 const char *const c_config_charset = cs_subset_string(NeoMutt->sub, "config_charset");
262 const char *const c_charset = cc_charset();
263 while ((line = mutt_file_read_line(line, &linelen, fp, &lineno, MUTT_RL_CONT)) != NULL)
264 {
265 const bool conv = c_config_charset && c_charset;
266 if (conv)
267 {
268 currentline = mutt_str_dup(line);
269 if (!currentline)
270 continue;
271 mutt_ch_convert_string(&currentline, c_config_charset, c_charset, MUTT_ICONV_NO_FLAGS);
272 }
273 else
274 {
275 currentline = line;
276 }
277
278 buf_strcpy(linebuf, currentline);
279
280 buf_reset(err);
281 line_rc = parse_rc_buffer(linebuf, token, err);
282 if (line_rc == MUTT_CMD_ERROR)
283 {
284 mutt_error("%s:%d: %s", rcfile, lineno, buf_string(err));
285 if (--rc < -MAX_ERRS)
286 {
287 if (conv)
288 FREE(&currentline);
289 break;
290 }
291 }
292 else if (line_rc == MUTT_CMD_WARNING)
293 {
294 /* Warning */
295 mutt_warning("%s:%d: %s", rcfile, lineno, buf_string(err));
296 warnings++;
297 }
298 else if (line_rc == MUTT_CMD_FINISH)
299 {
300 if (conv)
301 FREE(&currentline);
302 break; /* Found "finish" command */
303 }
304 else
305 {
306 if (rc < 0)
307 rc = -1;
308 }
309 if (conv)
310 FREE(&currentline);
311 }
312
313 FREE(&line);
314 mutt_file_fclose(&fp);
315 if (pid != -1)
316 filter_wait(pid);
317
318 if (rc)
319 {
320 /* the neomuttrc source keyword */
321 buf_reset(err);
322 buf_printf(err, (rc >= -MAX_ERRS) ? _("source: errors in %s") : _("source: reading aborted due to too many errors in %s"),
323 rcfile);
324 rc = -1;
325 }
326 else
327 {
328 /* Don't alias errors with warnings */
329 if (warnings > 0)
330 {
331 buf_printf(err, ngettext("source: %d warning in %s", "source: %d warnings in %s", warnings),
332 warnings, rcfile);
333 rc = -2;
334 }
335 }
336
337 if (!ispipe && !STAILQ_EMPTY(&MuttrcStack))
338 {
339 struct ListNode *np = STAILQ_FIRST(&MuttrcStack);
341 FREE(&np->data);
342 FREE(&np);
343 }
344
345 buf_pool_release(&token);
346 buf_pool_release(&linebuf);
347 return rc;
348}
int buf_printf(struct Buffer *buf, const char *fmt,...)
Format a string overwriting a Buffer.
Definition: buffer.c:178
void buf_reset(struct Buffer *buf)
Reset an existing Buffer.
Definition: buffer.c:93
static const char * buf_string(const struct Buffer *buf)
Convert a buffer to a const char * "string".
Definition: buffer.h:97
@ MUTT_CMD_ERROR
Error: Can't help the user.
Definition: command.h:37
@ MUTT_CMD_WARNING
Warning: Help given to the user.
Definition: command.h:38
@ MUTT_CMD_FINISH
Finish: Stop processing this file.
Definition: command.h:40
#define MAX_ERRS
Definition: commands.c:78
const char * cs_subset_string(const struct ConfigSubset *sub, const char *name)
Get a string config item by name.
Definition: helpers.c:292
const char * cc_charset(void)
Get the cached value of $charset.
Definition: config_cache.c:116
char * mutt_file_read_line(char *line, size_t *size, FILE *fp, int *line_num, ReadLineFlags flags)
Read a line from a file.
Definition: file.c:801
#define MUTT_RL_CONT
-continuation
Definition: file.h:41
#define mutt_file_fclose(FP)
Definition: file.h:148
int filter_wait(pid_t pid)
Wait for the exit of a process and return its status.
Definition: filter.c:219
#define mutt_warning(...)
Definition: logging2.h:90
#define mutt_error(...)
Definition: logging2.h:92
#define mutt_debug(LEVEL,...)
Definition: logging2.h:89
@ LL_DEBUG2
Log at debug level 2.
Definition: logging2.h:44
int mutt_ch_convert_string(char **ps, const char *from, const char *to, uint8_t flags)
Convert a string between encodings.
Definition: charset.c:830
#define MUTT_ICONV_NO_FLAGS
No flags are set.
Definition: charset.h:72
bool mutt_path_to_absolute(char *path, const char *reference)
Convert relative filepath to an absolute path.
Definition: path.c:332
bool mutt_str_equal(const char *a, const char *b)
Compare two strings.
Definition: string.c:709
size_t mutt_str_len(const char *a)
Calculate the length of a string, safely.
Definition: string.c:545
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:630
#define PATH_MAX
Definition: mutt.h:42
FILE * mutt_open_read(const char *path, pid_t *thepid)
Run a command to read from.
Definition: muttlib.c:736
#define STAILQ_FOREACH(var, head, field)
Definition: queue.h:352
#define STAILQ_EMPTY(head)
Definition: queue.h:348
enum CommandResult parse_rc_buffer(struct Buffer *line, struct Buffer *token, struct Buffer *err)
Parse a line of user config.
Definition: rc.c:46
Container for Accounts, Notifications.
Definition: neomutt.h:41
struct ConfigSubset * sub
Inherited config items.
Definition: neomutt.h:45
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ set_dump()

enum CommandResult set_dump ( ConfigDumpFlags  flags,
struct Buffer err 
)

Dump list of config variables into a file/pager.

Parameters
flagswhat configs to dump: see ConfigDumpFlags
errbuffer for error message
Returns
num See CommandResult

FIXME: Move me into parse/set.c. Note: this function currently depends on pager, which is the reason it is not included in the parse library.

Definition at line 853 of file commands.c.

854{
855 struct Buffer *tempfile = buf_pool_get();
856 buf_mktemp(tempfile);
857
858 FILE *fp_out = mutt_file_fopen(buf_string(tempfile), "w");
859 if (!fp_out)
860 {
861 // L10N: '%s' is the file name of the temporary file
862 buf_printf(err, _("Could not create temporary file %s"), buf_string(tempfile));
863 buf_pool_release(&tempfile);
864 return MUTT_CMD_ERROR;
865 }
866
867 dump_config(NeoMutt->sub->cs, flags, fp_out);
868
869 mutt_file_fclose(&fp_out);
870
871 struct PagerData pdata = { 0 };
872 struct PagerView pview = { &pdata };
873
874 pdata.fname = buf_string(tempfile);
875
876 pview.banner = "set";
878 pview.mode = PAGER_MODE_OTHER;
879
880 mutt_do_pager(&pview, NULL);
881 buf_pool_release(&tempfile);
882
883 return MUTT_CMD_SUCCESS;
884}
@ MUTT_CMD_SUCCESS
Success: Command worked.
Definition: command.h:39
bool dump_config(struct ConfigSet *cs, ConfigDumpFlags flags, FILE *fp)
Write all the config to a file.
Definition: dump.c:167
int mutt_do_pager(struct PagerView *pview, struct Email *e)
Display some page-able text to the user (help or attachment)
Definition: do_pager.c:123
#define mutt_file_fopen(PATH, MODE)
Definition: file.h:147
#define MUTT_PAGER_NO_FLAGS
No flags are set.
Definition: lib.h:60
@ PAGER_MODE_OTHER
Pager is invoked via 3rd path. Non-email content is likely to be shown.
Definition: lib.h:142
struct ConfigSet * cs
Parent ConfigSet.
Definition: subset.h:51
Data to be displayed by PagerView.
Definition: lib.h:161
const char * fname
Name of the file to read.
Definition: lib.h:165
Paged view into some data.
Definition: lib.h:172
struct PagerData * pdata
Data that pager displays. NOTNULL.
Definition: lib.h:173
enum PagerMode mode
Pager mode.
Definition: lib.h:174
PagerFlags flags
Additional settings to tweak pager's function.
Definition: lib.h:175
const char * banner
Title to display in status bar.
Definition: lib.h:176
#define buf_mktemp(buf)
Definition: tmp.h:33
+ Here is the call graph for this function:
+ Here is the caller graph for this function: