NeoMutt  2024-12-12-14-g7b49f7
Teaching an old dog new tricks
DOXYGEN
Loading...
Searching...
No Matches
ibar.c
Go to the documentation of this file.
1
63#include "config.h"
64#include <stdbool.h>
65#include "mutt/lib.h"
66#include "config/lib.h"
67#include "core/lib.h"
68#include "gui/lib.h"
69#include "lib.h"
70#include "color/lib.h"
71#include "expando/lib.h"
72#include "private_data.h"
73#include "shared_data.h"
74#include "status.h"
75
80{
86};
87
91static int ibar_recalc(struct MuttWindow *win)
92{
93 struct Buffer *buf = buf_pool_get();
94
95 struct IBarPrivateData *ibar_data = win->wdata;
96 struct IndexSharedData *shared = ibar_data->shared;
97 struct IndexPrivateData *priv = ibar_data->priv;
98
99 const struct Expando *c_status_format = cs_subset_expando(shared->sub, "status_format");
100 menu_status_line(buf, shared, priv->menu, win->state.cols, c_status_format);
101
102 if (!mutt_str_equal(buf_string(buf), ibar_data->status_format))
103 {
104 mutt_str_replace(&ibar_data->status_format, buf_string(buf));
105 win->actions |= WA_REPAINT;
106 mutt_debug(LL_DEBUG5, "recalc done, request WA_REPAINT\n");
107 }
108
109 const bool c_ts_enabled = cs_subset_bool(shared->sub, "ts_enabled");
110 if (c_ts_enabled && TsSupported)
111 {
112 buf_reset(buf);
113 const struct Expando *c_ts_status_format = cs_subset_expando(shared->sub, "ts_status_format");
114 menu_status_line(buf, shared, priv->menu, -1, c_ts_status_format);
115 if (!mutt_str_equal(buf_string(buf), ibar_data->ts_status_format))
116 {
118 win->actions |= WA_REPAINT;
119 mutt_debug(LL_DEBUG5, "recalc done, request WA_REPAINT\n");
120 }
121
122 buf_reset(buf);
123 const struct Expando *c_ts_icon_format = cs_subset_expando(shared->sub, "ts_icon_format");
124 menu_status_line(buf, shared, priv->menu, -1, c_ts_icon_format);
125 if (!mutt_str_equal(buf_string(buf), ibar_data->ts_icon_format))
126 {
127 mutt_str_replace(&ibar_data->ts_icon_format, buf_string(buf));
128 win->actions |= WA_REPAINT;
129 mutt_debug(LL_DEBUG5, "recalc done, request WA_REPAINT\n");
130 }
131 }
132
133 buf_pool_release(&buf);
134 return 0;
135}
136
140static int ibar_repaint(struct MuttWindow *win)
141{
142 struct IBarPrivateData *ibar_data = win->wdata;
143 struct IndexSharedData *shared = ibar_data->shared;
144
145 mutt_window_move(win, 0, 0);
148
149 mutt_window_move(win, 0, 0);
150 mutt_draw_statusline(win, win->state.cols, ibar_data->status_format,
151 mutt_str_len(ibar_data->status_format));
153
154 const bool c_ts_enabled = cs_subset_bool(shared->sub, "ts_enabled");
155 if (c_ts_enabled && TsSupported)
156 {
158 mutt_ts_icon(ibar_data->ts_icon_format);
159 }
160
161 mutt_debug(LL_DEBUG5, "repaint done\n");
162 return 0;
163}
164
169{
170 if (nc->event_type != NT_COLOR)
171 return 0;
172 if (!nc->global_data || !nc->event_data)
173 return -1;
174
175 struct EventColor *ev_c = nc->event_data;
176
177 // MT_COLOR_MAX is sent on `uncolor *`
178 if ((ev_c->cid != MT_COLOR_STATUS) && (ev_c->cid != MT_COLOR_NORMAL) &&
179 (ev_c->cid != MT_COLOR_MAX))
180 {
181 return 0;
182 }
183
184 struct MuttWindow *win_ibar = nc->global_data;
185 win_ibar->actions |= WA_REPAINT;
186 mutt_debug(LL_DEBUG5, "color done, request WA_REPAINT\n");
187
188 return 0;
189}
190
195{
196 if (nc->event_type != NT_CONFIG)
197 return 0;
198 if (!nc->global_data || !nc->event_data)
199 return -1;
200
201 struct EventConfig *ev_c = nc->event_data;
202 if (!ev_c->name)
203 return 0;
204 if ((ev_c->name[0] != 's') && (ev_c->name[0] != 't'))
205 return 0;
206
207 if (!mutt_str_equal(ev_c->name, "status_format") &&
208 !mutt_str_equal(ev_c->name, "ts_enabled") &&
209 !mutt_str_equal(ev_c->name, "ts_icon_format") &&
210 !mutt_str_equal(ev_c->name, "ts_status_format"))
211 {
212 return 0;
213 }
214
215 struct MuttWindow *win_ibar = nc->global_data;
216 win_ibar->actions |= WA_RECALC;
217 mutt_debug(LL_DEBUG5, "config done, request WA_RECALC\n");
218
219 return 0;
220}
221
232{
233 if (!nc->global_data)
234 return -1;
235
236 struct MuttWindow *win_ibar = nc->global_data;
237 win_ibar->actions |= WA_RECALC;
238 mutt_debug(LL_DEBUG5, "index done, request WA_RECALC\n");
239
240 return 0;
241}
242
246static int ibar_menu_observer(struct NotifyCallback *nc)
247{
248 if (nc->event_type != NT_MENU)
249 return 0;
250 if (!nc->global_data)
251 return -1;
252
253 struct MuttWindow *win_ibar = nc->global_data;
254 win_ibar->actions |= WA_RECALC;
255 mutt_debug(LL_DEBUG5, "menu done, request WA_RECALC\n");
256
257 return 0;
258}
259
264{
265 if (nc->event_type != NT_WINDOW)
266 return 0;
267 if (!nc->global_data)
268 return -1;
269
270 struct MuttWindow *win_ibar = nc->global_data;
271 struct EventWindow *ev_w = nc->event_data;
272 if (ev_w->win != win_ibar)
273 return 0;
274
276 {
277 win_ibar->actions |= WA_REPAINT;
278 mutt_debug(LL_DEBUG5, "window state done, request WA_REPAINT\n");
279 }
280 else if (nc->event_subtype == NT_WINDOW_DELETE)
281 {
282 struct MuttWindow *dlg = window_find_parent(win_ibar, WT_DLG_INDEX);
283 struct IndexSharedData *shared = dlg->wdata;
284
290
291 mutt_debug(LL_DEBUG5, "window delete done\n");
292 }
293
294 return 0;
295}
296
300static void ibar_data_free(struct MuttWindow *win, void **ptr)
301{
302 if (!ptr || !*ptr)
303 return;
304
305 struct IBarPrivateData *ibar_data = *ptr;
306
307 FREE(&ibar_data->status_format);
308 FREE(&ibar_data->ts_status_format);
309 FREE(&ibar_data->ts_icon_format);
310
311 FREE(ptr);
312}
313
321 struct IndexPrivateData *priv)
322{
323 struct IBarPrivateData *ibar_data = MUTT_MEM_CALLOC(1, struct IBarPrivateData);
324
325 ibar_data->shared = shared;
326 ibar_data->priv = priv;
327
328 return ibar_data;
329}
330
338struct MuttWindow *ibar_new(struct MuttWindow *parent, struct IndexSharedData *shared,
339 struct IndexPrivateData *priv)
340{
344
345 win_ibar->wdata = ibar_data_new(shared, priv);
346 win_ibar->wdata_free = ibar_data_free;
347 win_ibar->recalc = ibar_recalc;
348 win_ibar->repaint = ibar_repaint;
349
355
356 return win_ibar;
357}
void buf_reset(struct Buffer *buf)
Reset an existing Buffer.
Definition: buffer.c:76
static const char * buf_string(const struct Buffer *buf)
Convert a buffer to a const char * "string".
Definition: buffer.h:96
Color and attribute parsing.
void mutt_color_observer_remove(observer_t callback, void *global_data)
Remove an observer.
Definition: notify.c:71
void mutt_color_observer_add(observer_t callback, void *global_data)
Add an observer.
Definition: notify.c:61
@ MT_COLOR_MAX
Definition: color.h:90
@ MT_COLOR_STATUS
Status bar (takes a pattern)
Definition: color.h:71
@ MT_COLOR_NORMAL
Plain text.
Definition: color.h:55
bool cs_subset_bool(const struct ConfigSubset *sub, const char *name)
Get a boolean config item by name.
Definition: helpers.c:47
const struct Expando * cs_subset_expando(const struct ConfigSubset *sub, const char *name)
Get an Expando config item by name.
Definition: config_type.c:357
Convenience wrapper for the config headers.
Convenience wrapper for the core headers.
void mutt_draw_statusline(struct MuttWindow *win, int max_cols, const char *buf, size_t buflen)
Draw a highlighted status bar.
Definition: dlg_index.c:958
Parse Expando string.
#define mutt_debug(LEVEL,...)
Definition: logging2.h:89
static int ibar_menu_observer(struct NotifyCallback *nc)
Notification that a Menu has changed - Implements observer_t -.
Definition: ibar.c:246
static int ibar_window_observer(struct NotifyCallback *nc)
Notification that a Window has changed - Implements observer_t -.
Definition: ibar.c:263
static int ibar_config_observer(struct NotifyCallback *nc)
Notification that a Config Variable has changed - Implements observer_t -.
Definition: ibar.c:194
static int ibar_color_observer(struct NotifyCallback *nc)
Notification that a Color has changed - Implements observer_t -.
Definition: ibar.c:168
static int ibar_index_observer(struct NotifyCallback *nc)
Notification that the Index has changed - Implements observer_t -.
Definition: ibar.c:231
static int ibar_recalc(struct MuttWindow *win)
Recalculate the Window data - Implements MuttWindow::recalc() -.
Definition: ibar.c:91
static int ibar_repaint(struct MuttWindow *win)
Repaint the Window - Implements MuttWindow::repaint() -.
Definition: ibar.c:140
static void ibar_data_free(struct MuttWindow *win, void **ptr)
Free the private data - Implements MuttWindow::wdata_free() -.
Definition: ibar.c:300
Convenience wrapper for the gui headers.
static struct IBarPrivateData * ibar_data_new(struct IndexSharedData *shared, struct IndexPrivateData *priv)
Create the private data for the Index Bar (status)
Definition: ibar.c:320
struct MuttWindow * ibar_new(struct MuttWindow *parent, struct IndexSharedData *shared, struct IndexPrivateData *priv)
Create the Index Bar (status)
Definition: ibar.c:338
Data shared between Index, Pager and Sidebar.
@ LL_DEBUG5
Log at debug level 5.
Definition: logging2.h:47
#define FREE(x)
Definition: memory.h:55
#define MUTT_MEM_CALLOC(n, type)
Definition: memory.h:40
Convenience wrapper for the library headers.
bool notify_observer_remove(struct Notify *notify, const observer_t callback, const void *global_data)
Remove an observer from an object.
Definition: notify.c:230
bool notify_observer_add(struct Notify *notify, enum NotifyType type, observer_t callback, void *global_data)
Add an observer to an object.
Definition: notify.c:191
bool mutt_str_equal(const char *a, const char *b)
Compare two strings.
Definition: string.c:660
size_t mutt_str_len(const char *a)
Calculate the length of a string, safely.
Definition: string.c:496
char * mutt_str_replace(char **p, const char *s)
Replace one string with another.
Definition: string.c:280
const struct AttrColor * mutt_curses_set_normal_backed_color_by_id(enum ColorId cid)
Set the colour and attributes by the colour id.
Definition: mutt_curses.c:63
const struct AttrColor * mutt_curses_set_color_by_id(enum ColorId cid)
Set the colour and attributes by the colour id.
Definition: mutt_curses.c:79
struct MuttWindow * window_find_parent(struct MuttWindow *win, enum WindowType type)
Find a (grand-)parent of a Window by type.
Definition: mutt_window.c:558
struct MuttWindow * mutt_window_new(enum WindowType type, enum MuttWindowOrientation orient, enum MuttWindowSize size, int cols, int rows)
Create a new Window.
Definition: mutt_window.c:182
int mutt_window_move(struct MuttWindow *win, int col, int row)
Move the cursor in a Window.
Definition: mutt_window.c:297
void mutt_window_clrtoeol(struct MuttWindow *win)
Clear to the end of the line.
Definition: mutt_window.c:244
#define WA_RECALC
Recalculate the contents of the Window.
Definition: mutt_window.h:110
@ WT_DLG_INDEX
Index Dialog, dlg_index()
Definition: mutt_window.h:87
@ WT_STATUS_BAR
Status Bar containing extra info about the Index/Pager/etc.
Definition: mutt_window.h:102
@ MUTT_WIN_ORIENT_VERTICAL
Window uses all available vertical space.
Definition: mutt_window.h:39
@ NT_WINDOW_STATE
Window state has changed, e.g. WN_VISIBLE.
Definition: mutt_window.h:230
@ NT_WINDOW_DELETE
Window is about to be deleted.
Definition: mutt_window.h:229
#define WA_REPAINT
Redraw the contents of the Window.
Definition: mutt_window.h:111
#define MUTT_WIN_SIZE_UNLIMITED
Use as much space as possible.
Definition: mutt_window.h:53
@ MUTT_WIN_SIZE_FIXED
Window has a fixed size.
Definition: mutt_window.h:48
@ NT_WINDOW
MuttWindow has changed, NotifyWindow, EventWindow.
Definition: notify_type.h:57
@ NT_MENU
Menu has changed, MenuRedrawFlags.
Definition: notify_type.h:51
@ NT_CONFIG
Config has changed, NotifyConfig, EventConfig.
Definition: notify_type.h:43
@ NT_COLOR
Colour has changed, NotifyColor, EventColor.
Definition: notify_type.h:41
@ NT_ALL
Register for all notifications.
Definition: notify_type.h:35
Private state data for the Pager.
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
void menu_status_line(struct Buffer *buf, struct IndexSharedData *shared, struct Menu *menu, int max_cols, const struct Expando *exp)
Create the status line.
Definition: status.c:50
GUI display a user-configurable status line.
Key value store.
String manipulation buffer.
Definition: buffer.h:36
struct Notify * notify
Notifications: NotifyConfig, EventConfig.
Definition: subset.h:52
An Event that happened to a Colour.
Definition: notify2.h:55
enum ColorId cid
Colour ID that has changed.
Definition: notify2.h:56
A config-change event.
Definition: subset.h:71
const char * name
Name of config item that changed.
Definition: subset.h:73
An Event that happened to a Window.
Definition: mutt_window.h:239
struct MuttWindow * win
Window that changed.
Definition: mutt_window.h:240
Parsed Expando trees.
Definition: expando.h:41
Data to draw the Index Bar.
Definition: ibar.c:80
char * ts_icon_format
Cached terminal icon string.
Definition: ibar.c:85
struct IndexSharedData * shared
Shared Index data.
Definition: ibar.c:81
char * ts_status_format
Cached terminal status string.
Definition: ibar.c:84
char * status_format
Cached screen status string.
Definition: ibar.c:83
struct IndexPrivateData * priv
Private Index data.
Definition: ibar.c:82
Private state data for the Index.
Definition: private_data.h:35
struct Menu * menu
Menu controlling the index.
Definition: private_data.h:41
Data shared between Index, Pager and Sidebar.
Definition: shared_data.h:37
struct ConfigSubset * sub
Config set to use.
Definition: shared_data.h:38
struct Notify * notify
Notifications: NotifyIndex, IndexSharedData.
Definition: shared_data.h:44
int(* repaint)(struct MuttWindow *win)
Definition: mutt_window.h:187
struct WindowState state
Current state of the Window.
Definition: mutt_window.h:127
void * wdata
Private data.
Definition: mutt_window.h:145
struct Notify * notify
Notifications: NotifyWindow, EventWindow.
Definition: mutt_window.h:138
int(* recalc)(struct MuttWindow *win)
Definition: mutt_window.h:173
void(* wdata_free)(struct MuttWindow *win, void **ptr)
Definition: mutt_window.h:159
struct MuttWindow * parent
Parent Window.
Definition: mutt_window.h:135
WindowActionFlags actions
Actions to be performed, e.g. WA_RECALC.
Definition: mutt_window.h:132
Container for Accounts, Notifications.
Definition: neomutt.h:42
struct ConfigSubset * sub
Inherited config items.
Definition: neomutt.h:46
Data passed to a notification function.
Definition: observer.h:34
void * event_data
Data from notify_send()
Definition: observer.h:38
enum NotifyType event_type
Send: Event type, e.g. NT_ACCOUNT.
Definition: observer.h:36
int event_subtype
Send: Event subtype, e.g. NT_ACCOUNT_ADD.
Definition: observer.h:37
void * global_data
Data from notify_observer_add()
Definition: observer.h:39
short cols
Number of columns, can be MUTT_WIN_SIZE_UNLIMITED.
Definition: mutt_window.h:61
bool TsSupported
Terminal Setting is supported.
Definition: terminal.c:42
void mutt_ts_icon(char *str)
Set the icon in the terminal title bar.
Definition: terminal.c:133
void mutt_ts_status(char *str)
Set the text of the terminal title bar.
Definition: terminal.c:119