NeoMutt  2023-03-22
Teaching an old dog new tricks
DOXYGEN
status.c
Go to the documentation of this file.
1
29#include "config.h"
30#include <stdbool.h>
31#include <stdint.h>
32#include <stdio.h>
33#include "mutt/lib.h"
34#include "config/lib.h"
35#include "core/lib.h"
36#include "status.h"
37#include "index/lib.h"
38#include "menu/lib.h"
39#include "postpone/lib.h"
40#include "format_flags.h"
41#include "globals.h"
42#include "mutt_mailbox.h"
43#include "mutt_thread.h"
44#include "muttlib.h"
45#include "mview.h"
46
54static char *get_sort_str(char *buf, size_t buflen, enum SortType method)
55{
56 snprintf(buf, buflen, "%s%s%s", (method & SORT_REVERSE) ? "reverse-" : "",
57 (method & SORT_LAST) ? "last-" : "",
59 return buf;
60}
61
66{
68 struct Menu *menu;
69};
70
100static const char *status_format_str(char *buf, size_t buflen, size_t col, int cols,
101 char op, const char *src, const char *prec,
102 const char *if_str, const char *else_str,
103 intptr_t data, MuttFormatFlags flags)
104{
105 char fmt[128], tmp[128];
106 bool optional = (flags & MUTT_FORMAT_OPTIONAL);
107 struct MenuStatusLineData *msld = (struct MenuStatusLineData *) data;
108 struct IndexSharedData *shared = msld->shared;
109 struct MailboxView *mv = shared->mailboxview;
110 struct Mailbox *m = shared->mailbox;
111 struct Menu *menu = msld->menu;
112
113 *buf = '\0';
114 switch (op)
115 {
116 case 'b':
117 {
119 if (!optional)
120 {
121 snprintf(fmt, sizeof(fmt), "%%%sd", prec);
122 snprintf(buf, buflen, fmt, num);
123 }
124 else if (num == 0)
125 optional = false;
126 break;
127 }
128
129 case 'd':
130 {
131 const int num = m ? m->msg_deleted : 0;
132 if (!optional)
133 {
134 snprintf(fmt, sizeof(fmt), "%%%sd", prec);
135 snprintf(buf, buflen, fmt, num);
136 }
137 else if (num == 0)
138 optional = false;
139 break;
140 }
141
142 case 'D':
143 // If there's a descriptive name, use it. Otherwise, fall-through
144 if (m && m->name)
145 {
146 mutt_str_copy(tmp, m->name, sizeof(tmp));
147 snprintf(fmt, sizeof(fmt), "%%%ss", prec);
148 snprintf(buf, buflen, fmt, tmp);
149 break;
150 }
151 /* fallthrough */
152 case 'f':
153#ifdef USE_COMP_MBOX
154 if (m && m->compress_info && (m->realpath[0] != '\0'))
155 {
156 mutt_str_copy(tmp, m->realpath, sizeof(tmp));
157 mutt_pretty_mailbox(tmp, sizeof(tmp));
158 }
159 else
160#endif
161 if (m && (m->type == MUTT_NOTMUCH) && m->name)
162 {
163 mutt_str_copy(tmp, m->name, sizeof(tmp));
164 }
165 else if (m && !mutt_buffer_is_empty(&m->pathbuf))
166 {
167 mutt_str_copy(tmp, mailbox_path(m), sizeof(tmp));
168 mutt_pretty_mailbox(tmp, sizeof(tmp));
169 }
170 else
171 mutt_str_copy(tmp, _("(no mailbox)"), sizeof(tmp));
172
173 snprintf(fmt, sizeof(fmt), "%%%ss", prec);
174 snprintf(buf, buflen, fmt, tmp);
175 break;
176 case 'F':
177 {
178 const int num = m ? m->msg_flagged : 0;
179 if (!optional)
180 {
181 snprintf(fmt, sizeof(fmt), "%%%sd", prec);
182 snprintf(buf, buflen, fmt, num);
183 }
184 else if (num == 0)
185 optional = false;
186 break;
187 }
188
189 case 'h':
190 snprintf(fmt, sizeof(fmt), "%%%ss", prec);
191 snprintf(buf, buflen, fmt, NONULL(ShortHostname));
192 break;
193
194 case 'l':
195 {
196 const off_t num = m ? m->size : 0;
197 if (!optional)
198 {
199 snprintf(fmt, sizeof(fmt), "%%%ss", prec);
200 mutt_str_pretty_size(tmp, sizeof(tmp), num);
201 snprintf(buf, buflen, fmt, tmp);
202 }
203 else if (num == 0)
204 optional = false;
205 break;
206 }
207
208 case 'L':
209 if (!optional)
210 {
211 snprintf(fmt, sizeof(fmt), "%%%ss", prec);
212 mutt_str_pretty_size(tmp, sizeof(tmp), mv ? mv->vsize : 0);
213 snprintf(buf, buflen, fmt, tmp);
214 }
215 else if (!mview_has_limit(mv))
216 optional = false;
217 break;
218
219 case 'm':
220 {
221 const int num = m ? m->msg_count : 0;
222 if (!optional)
223 {
224 snprintf(fmt, sizeof(fmt), "%%%sd", prec);
225 snprintf(buf, buflen, fmt, num);
226 }
227 else if (num == 0)
228 optional = false;
229 break;
230 }
231
232 case 'M':
233 if (!optional)
234 {
235 snprintf(fmt, sizeof(fmt), "%%%sd", prec);
236 snprintf(buf, buflen, fmt, m ? m->vcount : 0);
237 }
238 else if (!mview_has_limit(mv))
239 optional = false;
240 break;
241
242 case 'n':
243 {
244 const int num = m ? m->msg_new : 0;
245 if (!optional)
246 {
247 snprintf(fmt, sizeof(fmt), "%%%sd", prec);
248 snprintf(buf, buflen, fmt, num);
249 }
250 else if (num == 0)
251 optional = false;
252 break;
253 }
254
255 case 'o':
256 {
257 const int num = m ? (m->msg_unread - m->msg_new) : 0;
258 if (!optional)
259 {
260 snprintf(fmt, sizeof(fmt), "%%%sd", prec);
261 snprintf(buf, buflen, fmt, num);
262 }
263 else if (num == 0)
264 optional = false;
265 break;
266 }
267
268 case 'p':
269 {
270 const int count = mutt_num_postponed(m, false);
271 if (!optional)
272 {
273 snprintf(fmt, sizeof(fmt), "%%%sd", prec);
274 snprintf(buf, buflen, fmt, count);
275 }
276 else if (count == 0)
277 optional = false;
278 break;
279 }
280
281 case 'P':
282 {
283 if (!menu)
284 break;
285 char *cp = NULL;
286 if (menu->top + menu->page_len >= menu->max)
287 {
288 cp = menu->top ?
289 /* L10N: Status bar message: the end of the list emails is visible in the index */
290 _("end") :
291 /* L10N: Status bar message: all the emails are visible in the index */
292 _("all");
293 }
294 else
295 {
296 int count = (100 * (menu->top + menu->page_len)) / menu->max;
297 snprintf(tmp, sizeof(tmp), "%d%%", count);
298 cp = tmp;
299 }
300 snprintf(fmt, sizeof(fmt), "%%%ss", prec);
301 snprintf(buf, buflen, fmt, cp);
302 break;
303 }
304
305 case 'r':
306 {
307 size_t i = 0;
308
309 if (m)
310 {
311 i = OptAttachMsg ? 3 :
312 ((m->readonly || m->dontwrite) ? 2 :
313 (m->changed ||
314 /* deleted doesn't necessarily mean changed in IMAP */
315 (m->type != MUTT_IMAP && m->msg_deleted)) ?
316 1 :
317 0);
318 }
319
320 const struct MbTable *c_status_chars = cs_subset_mbtable(NeoMutt->sub, "status_chars");
321 if (!c_status_chars || !c_status_chars->len)
322 buf[0] = '\0';
323 else if (i >= c_status_chars->len)
324 snprintf(buf, buflen, "%s", c_status_chars->chars[0]);
325 else
326 snprintf(buf, buflen, "%s", c_status_chars->chars[i]);
327 break;
328 }
329
330 case 'R':
331 {
332 const int read = m ? (m->msg_count - m->msg_unread) : 0;
333 if (!optional)
334 {
335 snprintf(fmt, sizeof(fmt), "%%%sd", prec);
336 snprintf(buf, buflen, fmt, read);
337 }
338 else if (read == 0)
339 optional = false;
340 break;
341 }
342
343 case 's':
344 {
345 snprintf(fmt, sizeof(fmt), "%%%ss", prec);
346 const short c_sort = cs_subset_sort(NeoMutt->sub, "sort");
347 snprintf(buf, buflen, fmt, get_sort_str(tmp, sizeof(tmp), c_sort));
348 break;
349 }
350
351 case 'S':
352 {
353 snprintf(fmt, sizeof(fmt), "%%%ss", prec);
354 const short c_sort_aux = cs_subset_sort(NeoMutt->sub, "sort_aux");
355 snprintf(buf, buflen, fmt, get_sort_str(tmp, sizeof(tmp), c_sort_aux));
356 break;
357 }
358
359 case 't':
360 {
361 const int num = m ? m->msg_tagged : 0;
362 if (!optional)
363 {
364 snprintf(fmt, sizeof(fmt), "%%%sd", prec);
365 snprintf(buf, buflen, fmt, num);
366 }
367 else if (num == 0)
368 optional = false;
369 break;
370 }
371
372 case 'T':
373 {
374 const enum UseThreads c_use_threads = mutt_thread_style();
375 if (!optional)
376 {
377 snprintf(fmt, sizeof(fmt), "%%%ss", prec);
378 snprintf(buf, buflen, fmt, get_use_threads_str(c_use_threads));
379 }
380 else if (c_use_threads == UT_FLAT)
381 optional = false;
382 break;
383 }
384
385 case 'u':
386 if (!optional)
387 {
388 snprintf(fmt, sizeof(fmt), "%%%sd", prec);
389 snprintf(buf, buflen, fmt, m ? m->msg_unread : 0);
390 }
391 else if (!m || (m->msg_unread == 0))
392 optional = false;
393 break;
394
395 case 'v':
396 snprintf(buf, buflen, "%s", mutt_make_version());
397 break;
398
399 case 'V':
400 if (!optional)
401 {
402 snprintf(fmt, sizeof(fmt), "%%%ss", prec);
403 snprintf(buf, buflen, fmt, mview_has_limit(mv) ? mv->pattern : "");
404 }
405 else if (!mview_has_limit(mv))
406 optional = false;
407 break;
408
409 case 0:
410 *buf = '\0';
411 return src;
412
413 default:
414 snprintf(buf, buflen, "%%%s%c", prec, op);
415 break;
416 }
417
418 if (optional)
419 {
420 mutt_expando_format(buf, buflen, col, cols, if_str, status_format_str, data,
422 }
423 else if (flags & MUTT_FORMAT_OPTIONAL)
424 {
425 mutt_expando_format(buf, buflen, col, cols, else_str, status_format_str,
427 }
428
429 /* We return the format string, unchanged */
430 return src;
431}
432
444void menu_status_line(char *buf, size_t buflen, struct IndexSharedData *shared,
445 struct Menu *menu, int cols, const char *fmt)
446{
447 struct MenuStatusLineData data = { shared, menu };
448
449 mutt_expando_format(buf, buflen, 0, cols, fmt, status_format_str,
450 (intptr_t) &data, MUTT_FORMAT_NO_FLAGS);
451}
bool mutt_buffer_is_empty(const struct Buffer *buf)
Is the Buffer empty?
Definition: buffer.c:298
struct MbTable * cs_subset_mbtable(const struct ConfigSubset *sub, const char *name)
Get a Multibyte table config item by name.
Definition: helpers.c:145
short cs_subset_sort(const struct ConfigSubset *sub, const char *name)
Get a sort config item by name.
Definition: helpers.c:292
Convenience wrapper for the config headers.
Convenience wrapper for the core headers.
void mutt_pretty_mailbox(char *buf, size_t buflen)
Shorten a mailbox path using '~' or '='.
Definition: muttlib.c:523
Flags to control mutt_expando_format()
#define MUTT_FORMAT_NO_FLAGS
No flags are set.
Definition: format_flags.h:30
#define MUTT_FORMAT_OPTIONAL
Allow optional field processing.
Definition: format_flags.h:33
uint8_t MuttFormatFlags
Flags for mutt_expando_format(), e.g. MUTT_FORMAT_FORCESUBJ.
Definition: format_flags.h:29
char * ShortHostname
Short version of the hostname.
Definition: globals.c:39
bool OptAttachMsg
(pseudo) used by attach-message
Definition: globals.c:65
Global variables.
static const char * status_format_str(char *buf, size_t buflen, size_t col, int cols, char op, const char *src, const char *prec, const char *if_str, const char *else_str, intptr_t data, MuttFormatFlags flags)
Create the status bar string - Implements format_t -.
Definition: status.c:100
void mutt_expando_format(char *buf, size_t buflen, size_t col, int cols, const char *src, format_t callback, intptr_t data, MuttFormatFlags flags)
Expand expandos (x) in a string -.
Definition: muttlib.c:778
GUI manage the main index (list of emails)
static const char * mailbox_path(const struct Mailbox *m)
Get the Mailbox's path string.
Definition: mailbox.h:209
@ MUTT_NOTMUCH
'Notmuch' (virtual) Mailbox type
Definition: mailbox.h:51
@ MUTT_IMAP
'IMAP' Mailbox type
Definition: mailbox.h:50
const char * mutt_map_get_name(int val, const struct Mapping *map)
Lookup a string for a constant.
Definition: mapping.c:42
GUI present the user with a selectable list.
Convenience wrapper for the library headers.
#define _(a)
Definition: message.h:28
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:652
int mutt_mailbox_check(struct Mailbox *m_cur, CheckStatsFlags flags)
Check all all Mailboxes for new mail.
Definition: mutt_mailbox.c:156
Mailbox helper functions.
const char * get_use_threads_str(enum UseThreads value)
Convert UseThreads enum to string.
Definition: mutt_thread.c:107
enum UseThreads mutt_thread_style(void)
Which threading style is active?
Definition: mutt_thread.c:89
Create/manipulate threading in emails.
UseThreads
Which threading style is active, $use_threads.
Definition: mutt_thread.h:83
@ UT_FLAT
Unthreaded.
Definition: mutt_thread.h:85
const char * mutt_make_version(void)
Generate the NeoMutt version string.
Definition: muttlib.c:1471
void mutt_str_pretty_size(char *buf, size_t buflen, size_t num)
Display an abbreviated size, like 3.4K.
Definition: muttlib.c:1674
Some miscellaneous functions.
bool mview_has_limit(const struct MailboxView *mv)
Is a limit active?
Definition: mview.c:435
The "currently-open" mailbox.
#define MUTT_MAILBOX_CHECK_NO_FLAGS
No flags are set.
Definition: mxapi.h:74
Postponed Emails.
int mutt_num_postponed(struct Mailbox *m, bool force)
Return the number of postponed messages.
Definition: postpone.c:69
const struct Mapping SortMethods[]
Sort methods for '$sort' for the index.
Definition: mutt_config.c:76
#define SORT_MASK
Mask for the sort id.
Definition: sort2.h:74
#define SORT_LAST
Sort thread by last-X, e.g. received date.
Definition: sort2.h:76
SortType
Methods for sorting.
Definition: sort2.h:38
#define SORT_REVERSE
Reverse the order of the sort.
Definition: sort2.h:75
void menu_status_line(char *buf, size_t buflen, struct IndexSharedData *shared, struct Menu *menu, int cols, const char *fmt)
Create the status line.
Definition: status.c:444
static char * get_sort_str(char *buf, size_t buflen, enum SortType method)
Get the sort method as a string.
Definition: status.c:54
GUI display a user-configurable status line.
#define NONULL(x)
Definition: string2.h:37
Data shared between Index, Pager and Sidebar.
Definition: shared_data.h:37
struct MailboxView * mailboxview
Current Mailbox view.
Definition: shared_data.h:39
struct Mailbox * mailbox
Current Mailbox.
Definition: shared_data.h:41
The "current" mailbox.
Definition: mview.h:38
off_t vsize
Size (in bytes) of the messages shown.
Definition: mview.h:39
char * pattern
Limit pattern string.
Definition: mview.h:40
A mailbox.
Definition: mailbox.h:79
int vcount
The number of virtual messages.
Definition: mailbox.h:99
bool changed
Mailbox has been modified.
Definition: mailbox.h:110
char * realpath
Used for duplicate detection, context comparison, and the sidebar.
Definition: mailbox.h:81
int msg_new
Number of new messages.
Definition: mailbox.h:92
int msg_count
Total number of messages.
Definition: mailbox.h:88
enum MailboxType type
Mailbox type.
Definition: mailbox.h:102
char * name
A short name for the Mailbox.
Definition: mailbox.h:82
struct Buffer pathbuf
Path of the Mailbox.
Definition: mailbox.h:80
int msg_deleted
Number of deleted messages.
Definition: mailbox.h:93
bool dontwrite
Don't write the mailbox on close.
Definition: mailbox.h:111
off_t size
Size of the Mailbox.
Definition: mailbox.h:84
int msg_flagged
Number of flagged messages.
Definition: mailbox.h:90
void * compress_info
Compressed mbox module private data.
Definition: mailbox.h:120
bool readonly
Don't allow changes to the mailbox.
Definition: mailbox.h:115
int msg_tagged
How many messages are tagged?
Definition: mailbox.h:94
int msg_unread
Number of unread messages.
Definition: mailbox.h:89
Multibyte character table.
Definition: mbtable.h:34
int len
Number of characters.
Definition: mbtable.h:36
char ** chars
The array of multibyte character strings.
Definition: mbtable.h:37
Data for creating a Menu line.
Definition: status.c:66
struct IndexSharedData * shared
Data shared between Index, Pager and Sidebar.
Definition: status.c:67
struct Menu * menu
Current Menu.
Definition: status.c:68
Definition: lib.h:70
int top
Entry that is the top of the current page.
Definition: lib.h:81
int max
Number of entries in the menu.
Definition: lib.h:72
int page_len
Number of entries per screen.
Definition: lib.h:75
Container for Accounts, Notifications.
Definition: neomutt.h:37
struct ConfigSubset * sub
Inherited config items.
Definition: neomutt.h:39