NeoMutt  2025-01-09-81-g753ae0
Teaching an old dog new tricks
DOXYGEN
Loading...
Searching...
No Matches
config.c
Go to the documentation of this file.
1
31#include "config.h"
32#include <stdbool.h>
33#include <stddef.h>
34#include "mutt/lib.h"
35#include "config/lib.h"
36#include "lib.h"
37#include "expando/lib.h"
38#include "sort.h"
39
43static const struct Mapping BrowserSortMethods[] = {
44 // clang-format off
45 { "alpha", BROWSER_SORT_ALPHA },
46 { "count", BROWSER_SORT_COUNT },
47 { "date", BROWSER_SORT_DATE },
48 { "desc", BROWSER_SORT_DESC },
49 { "size", BROWSER_SORT_SIZE },
50 { "new", BROWSER_SORT_NEW },
51 { "unsorted", BROWSER_SORT_UNSORTED },
52 // Compatibility
53 { "unread", BROWSER_SORT_NEW },
54 { NULL, 0 },
55 // clang-format on
56};
57
64struct ExpandoNode *parse_folder_date(const char *str, struct ExpandoFormat *fmt,
65 int did, int uid, ExpandoParserFlags flags,
66 const char **parsed_until,
67 struct ExpandoParseError *err)
68{
69 if (flags & EP_CONDITIONAL)
70 {
71 return node_conddate_parse(str, did, uid, parsed_until, err);
72 }
73
74 return node_expando_parse_enclosure(str, did, uid, ']', fmt, parsed_until, err);
75}
76
84static const struct ExpandoDefinition FolderFormatDef[] = {
85 // clang-format off
86 { "*", "padding-soft", ED_GLOBAL, ED_GLO_PADDING_SOFT, node_padding_parse },
87 { ">", "padding-hard", ED_GLOBAL, ED_GLO_PADDING_HARD, node_padding_parse },
88 { "|", "padding-eol", ED_GLOBAL, ED_GLO_PADDING_EOL, node_padding_parse },
89 { " ", "padding-space", ED_GLOBAL, ED_GLO_PADDING_SPACE, NULL },
90 { "a", "notify", ED_FOLDER, ED_FOL_NOTIFY, NULL },
91 { "C", "number", ED_FOLDER, ED_FOL_NUMBER, NULL },
92 { "d", "date", ED_FOLDER, ED_FOL_DATE, NULL },
93 { "D", "date-format", ED_FOLDER, ED_FOL_DATE_FORMAT, NULL },
94 { "f", "filename", ED_FOLDER, ED_FOL_FILENAME, NULL },
95 { "F", "file-mode", ED_FOLDER, ED_FOL_FILE_MODE, NULL },
96 { "g", "file-group", ED_FOLDER, ED_FOL_FILE_GROUP, NULL },
97 { "i", "description", ED_FOLDER, ED_FOL_DESCRIPTION, NULL },
98 { "l", "hard-links", ED_FOLDER, ED_FOL_HARD_LINKS, NULL },
99 { "m", "message-count", ED_FOLDER, ED_FOL_MESSAGE_COUNT, NULL },
100 { "n", "unread-count", ED_FOLDER, ED_FOL_UNREAD_COUNT, NULL },
101 { "N", "new-mail", ED_FOLDER, ED_FOL_NEW_MAIL, NULL },
102 { "p", "poll", ED_FOLDER, ED_FOL_POLL, NULL },
103 { "s", "file-size", ED_FOLDER, ED_FOL_FILE_SIZE, NULL },
104 { "t", "tagged", ED_FOLDER, ED_FOL_TAGGED, NULL },
105 { "u", "file-owner", ED_FOLDER, ED_FOL_FILE_OWNER, NULL },
107 { NULL, NULL, 0, -1, NULL }
108 // clang-format on
109};
110
117static const struct ExpandoDefinition GroupIndexFormatDef[] = {
118 // clang-format off
119 { "*", "padding-soft", ED_GLOBAL, ED_GLO_PADDING_SOFT, node_padding_parse },
120 { ">", "padding-hard", ED_GLOBAL, ED_GLO_PADDING_HARD, node_padding_parse },
121 { "|", "padding-eol", ED_GLOBAL, ED_GLO_PADDING_EOL, node_padding_parse },
122 { "a", "notify", ED_FOLDER, ED_FOL_NOTIFY, NULL },
123 { "C", "number", ED_FOLDER, ED_FOL_NUMBER, NULL },
124 { "d", "description", ED_FOLDER, ED_FOL_DESCRIPTION, NULL },
125 { "f", "newsgroup", ED_FOLDER, ED_FOL_NEWSGROUP, NULL },
126 { "M", "flags", ED_FOLDER, ED_FOL_FLAGS, NULL },
127 { "n", "new-count", ED_FOLDER, ED_FOL_NEW_COUNT, NULL },
128 { "N", "flags2", ED_FOLDER, ED_FOL_FLAGS2, NULL },
129 { "p", "poll", ED_FOLDER, ED_FOL_POLL, NULL },
130 { "s", "unread-count", ED_FOLDER, ED_FOL_UNREAD_COUNT, NULL },
131 { NULL, NULL, 0, -1, NULL }
132 // clang-format on
133};
134
138static struct ConfigDef BrowserVars[] = {
139 // clang-format off
140 { "browser_abbreviate_mailboxes", DT_BOOL, true, 0, NULL,
141 "Abbreviate mailboxes using '~' and '=' in the browser"
142 },
144 "Sort method for the browser"
145 },
146 { "folder_format", DT_EXPANDO|D_NOT_EMPTY, IP "%2C %t %N %F %2l %-8.8u %-8.8g %8s %d %i", IP &FolderFormatDef, NULL,
147 "printf-like format string for the browser's display of folders"
148 },
149 { "group_index_format", DT_EXPANDO|D_NOT_EMPTY, IP "%4C %M%N %5s %-45.45f %d", IP &GroupIndexFormatDef, NULL,
150 "(nntp) printf-like format string for the browser's display of newsgroups"
151 },
152 { "mailbox_folder_format", DT_EXPANDO|D_NOT_EMPTY, IP "%2C %<n?%6n& > %6m %i", IP &FolderFormatDef, NULL,
153 "printf-like format string for the browser's display of mailbox folders"
154 },
155 { "mask", DT_REGEX|D_REGEX_MATCH_CASE|D_REGEX_ALLOW_NOT|D_REGEX_NOSUB, IP "!^\\.[^.]", 0, NULL,
156 "Only display files/dirs matching this regex in the browser"
157 },
158 { "show_only_unread", DT_BOOL, false, 0, NULL,
159 "(nntp) Only show subscribed newsgroups with unread articles"
160 },
161 { "browser_sort_dirs_first", DT_BOOL, false, 0, NULL,
162 "Group directories before files in the browser"
163 },
164
165 { "sort_browser", DT_SYNONYM, IP "browser_sort", IP "2024-11-20" },
166
167 { NULL },
168 // clang-format on
169};
170
175{
177}
static struct ConfigDef BrowserVars[]
Config definitions for the browser.
Definition: config.c:138
static const struct ExpandoDefinition GroupIndexFormatDef[]
Expando definitions.
Definition: config.c:117
static const struct ExpandoDefinition FolderFormatDef[]
Expando definitions.
Definition: config.c:84
static const struct Mapping BrowserSortMethods[]
Sort methods for the folder/dir browser.
Definition: config.c:43
@ ED_FOL_POLL
FolderFile.poll_new_mail.
Definition: lib.h:135
@ ED_FOL_NOTIFY
FolderFile.notify_user.
Definition: lib.h:133
@ ED_FOL_NEW_COUNT
FolderFile.nd (NntpMboxData)
Definition: lib.h:131
@ ED_FOL_FILE_OWNER
FolderFile.uid.
Definition: lib.h:124
@ ED_FOL_FILE_GROUP
FolderFile.gid.
Definition: lib.h:122
@ ED_FOL_FILENAME
FolderFile.name.
Definition: lib.h:121
@ ED_FOL_DATE_FORMAT
FolderFile.mtime.
Definition: lib.h:118
@ ED_FOL_DATE_STRF
FolderFile.mtime.
Definition: lib.h:119
@ ED_FOL_UNREAD_COUNT
FolderFile.msg_unread.
Definition: lib.h:137
@ ED_FOL_FLAGS2
FolderFile.nd (NntpMboxData)
Definition: lib.h:127
@ ED_FOL_FILE_MODE
FolderFile.move.
Definition: lib.h:123
@ ED_FOL_NEW_MAIL
FolderFile.has_new_mail.
Definition: lib.h:132
@ ED_FOL_FILE_SIZE
FolderFile.size.
Definition: lib.h:125
@ ED_FOL_HARD_LINKS
FolderFile.nlink.
Definition: lib.h:128
@ ED_FOL_DATE
FolderFile.mtime.
Definition: lib.h:117
@ ED_FOL_TAGGED
FolderFile.tagged.
Definition: lib.h:136
@ ED_FOL_NUMBER
Folder.num.
Definition: lib.h:134
@ ED_FOL_DESCRIPTION
FolderFile.desc, FolderFile.name.
Definition: lib.h:120
@ ED_FOL_MESSAGE_COUNT
FolderFile.msg_count.
Definition: lib.h:129
@ ED_FOL_NEWSGROUP
FolderFile.name.
Definition: lib.h:130
@ ED_FOL_FLAGS
FolderFile.nd (NntpMboxData)
Definition: lib.h:126
@ BROWSER_SORT_ALPHA
Sort alphabetically by name.
Definition: sort.h:31
@ BROWSER_SORT_UNSORTED
Sort into the raw order.
Definition: sort.h:37
@ BROWSER_SORT_COUNT
Sort by total message count.
Definition: sort.h:32
@ BROWSER_SORT_DATE
Sort by date.
Definition: sort.h:33
@ BROWSER_SORT_NEW
Sort by count of new messages.
Definition: sort.h:35
@ BROWSER_SORT_SIZE
Sort by size.
Definition: sort.h:36
@ BROWSER_SORT_DESC
Sort by description.
Definition: sort.h:34
Convenience wrapper for the config headers.
bool cs_register_variables(const struct ConfigSet *cs, struct ConfigDef vars[])
Register a set of config items.
Definition: set.c:289
#define IP
Definition: set.h:54
uint8_t ExpandoParserFlags
Flags for expando_parse(), e.g. EP_CONDITIONAL.
Definition: definition.h:33
#define EP_CONDITIONAL
Expando is being used as a condition.
Definition: definition.h:35
@ ED_FOLDER
Folder ED_FOL_ ExpandoDataFolder.
Definition: domain.h:43
@ ED_GLOBAL
Global ED_GLO_ ExpandoDataGlobal.
Definition: domain.h:44
Parse Expando string.
bool config_init_browser(struct ConfigSet *cs)
Register browser config variables - Implements module_init_config_t -.
Definition: config.c:174
struct ExpandoNode * node_padding_parse(const char *str, struct ExpandoFormat *fmt, int did, int uid, ExpandoParserFlags flags, const char **parsed_until, struct ExpandoParseError *err)
Parse a Padding Expando - Implements ExpandoDefinition::parse() -.
Definition: node_padding.c:234
struct ExpandoNode * parse_folder_date(const char *str, struct ExpandoFormat *fmt, int did, int uid, ExpandoParserFlags flags, const char **parsed_until, struct ExpandoParseError *err)
Parse a Date Expando - Implements ExpandoDefinition::parse() -.
Definition: config.c:64
Convenience wrapper for the library headers.
struct ExpandoNode * node_conddate_parse(const char *str, int did, int uid, const char **parsed_until, struct ExpandoParseError *err)
Parse a CondDate format string.
struct ExpandoNode * node_expando_parse_enclosure(const char *str, int did, int uid, char terminator, struct ExpandoFormat *fmt, const char **parsed_until, struct ExpandoParseError *err)
Parse an enclosed Expando.
Definition: node_expando.c:349
Sidebar sorting functions.
Key value store.
Definition: set.h:64
Container for lots of config items.
Definition: set.h:250
Definition of a format string.
Definition: definition.h:44
Formatting information for an Expando.
Definition: node.h:53
Basic Expando Node.
Definition: node.h:67
int uid
Unique ID, e.g. ED_EMA_SIZE.
Definition: node.h:70
int did
Domain ID, e.g. ED_EMAIL.
Definition: node.h:69
Buffer for parsing errors.
Definition: parse.h:37
Mapping between user-readable string and a constant.
Definition: mapping.h:33
#define D_REGEX_ALLOW_NOT
Regex can begin with '!'.
Definition: types.h:106
#define D_REGEX_MATCH_CASE
Case-sensitive matching.
Definition: types.h:105
@ DT_BOOL
boolean option
Definition: types.h:32
@ DT_SYNONYM
synonym for another variable
Definition: types.h:45
@ DT_SORT
sorting methods
Definition: types.h:43
@ DT_EXPANDO
an expando
Definition: types.h:34
@ DT_REGEX
regular expressions
Definition: types.h:41
#define D_SORT_REVERSE
Sort flag for -reverse prefix.
Definition: types.h:119
#define D_NOT_EMPTY
Empty strings are not allowed.
Definition: types.h:79
#define D_REGEX_NOSUB
Do not report what was matched (REG_NOSUB)
Definition: types.h:107
@ ED_GLO_PADDING_EOL
Padding to end-of-line.
Definition: uid.h:38
@ ED_GLO_PADDING_HARD
Hard Padding.
Definition: uid.h:39
@ ED_GLO_PADDING_SOFT
Soft Padding.
Definition: uid.h:40
@ ED_GLO_PADDING_SPACE
Space Padding.
Definition: uid.h:41