NeoMutt  2024-10-02-37-gfa9146
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 "private_data.h"
72#include "shared_data.h"
73#include "status.h"
74
79{
85};
86
90static int ibar_recalc(struct MuttWindow *win)
91{
92 struct Buffer *buf = buf_pool_get();
93
94 struct IBarPrivateData *ibar_data = win->wdata;
95 struct IndexSharedData *shared = ibar_data->shared;
96 struct IndexPrivateData *priv = ibar_data->priv;
97
98 const struct Expando *c_status_format = cs_subset_expando(shared->sub, "status_format");
99 menu_status_line(buf, shared, priv->menu, win->state.cols, c_status_format);
100
101 if (!mutt_str_equal(buf_string(buf), ibar_data->status_format))
102 {
103 mutt_str_replace(&ibar_data->status_format, buf_string(buf));
104 win->actions |= WA_REPAINT;
105 mutt_debug(LL_DEBUG5, "recalc done, request WA_REPAINT\n");
106 }
107
108 const bool c_ts_enabled = cs_subset_bool(shared->sub, "ts_enabled");
109 if (c_ts_enabled && TsSupported)
110 {
111 buf_reset(buf);
112 const struct Expando *c_ts_status_format = cs_subset_expando(shared->sub, "ts_status_format");
113 menu_status_line(buf, shared, priv->menu, -1, c_ts_status_format);
114 if (!mutt_str_equal(buf_string(buf), ibar_data->ts_status_format))
115 {
117 win->actions |= WA_REPAINT;
118 mutt_debug(LL_DEBUG5, "recalc done, request WA_REPAINT\n");
119 }
120
121 buf_reset(buf);
122 const struct Expando *c_ts_icon_format = cs_subset_expando(shared->sub, "ts_icon_format");
123 menu_status_line(buf, shared, priv->menu, -1, c_ts_icon_format);
124 if (!mutt_str_equal(buf_string(buf), ibar_data->ts_icon_format))
125 {
126 mutt_str_replace(&ibar_data->ts_icon_format, buf_string(buf));
127 win->actions |= WA_REPAINT;
128 mutt_debug(LL_DEBUG5, "recalc done, request WA_REPAINT\n");
129 }
130 }
131
132 buf_pool_release(&buf);
133 return 0;
134}
135
139static int ibar_repaint(struct MuttWindow *win)
140{
141 struct IBarPrivateData *ibar_data = win->wdata;
142 struct IndexSharedData *shared = ibar_data->shared;
143
144 mutt_window_move(win, 0, 0);
147
148 mutt_window_move(win, 0, 0);
149 mutt_draw_statusline(win, win->state.cols, ibar_data->status_format,
150 mutt_str_len(ibar_data->status_format));
152
153 const bool c_ts_enabled = cs_subset_bool(shared->sub, "ts_enabled");
154 if (c_ts_enabled && TsSupported)
155 {
157 mutt_ts_icon(ibar_data->ts_icon_format);
158 }
159
160 mutt_debug(LL_DEBUG5, "repaint done\n");
161 return 0;
162}
163
168{
169 if (nc->event_type != NT_COLOR)
170 return 0;
171 if (!nc->global_data || !nc->event_data)
172 return -1;
173
174 struct EventColor *ev_c = nc->event_data;
175
176 // MT_COLOR_MAX is sent on `uncolor *`
177 if ((ev_c->cid != MT_COLOR_STATUS) && (ev_c->cid != MT_COLOR_NORMAL) &&
178 (ev_c->cid != MT_COLOR_MAX))
179 {
180 return 0;
181 }
182
183 struct MuttWindow *win_ibar = nc->global_data;
184 win_ibar->actions |= WA_REPAINT;
185 mutt_debug(LL_DEBUG5, "color done, request WA_REPAINT\n");
186
187 return 0;
188}
189
194{
195 if (nc->event_type != NT_CONFIG)
196 return 0;
197 if (!nc->global_data || !nc->event_data)
198 return -1;
199
200 struct EventConfig *ev_c = nc->event_data;
201 if (!ev_c->name)
202 return 0;
203 if ((ev_c->name[0] != 's') && (ev_c->name[0] != 't'))
204 return 0;
205
206 if (!mutt_str_equal(ev_c->name, "status_format") &&
207 !mutt_str_equal(ev_c->name, "ts_enabled") &&
208 !mutt_str_equal(ev_c->name, "ts_icon_format") &&
209 !mutt_str_equal(ev_c->name, "ts_status_format"))
210 {
211 return 0;
212 }
213
214 struct MuttWindow *win_ibar = nc->global_data;
215 win_ibar->actions |= WA_RECALC;
216 mutt_debug(LL_DEBUG5, "config done, request WA_RECALC\n");
217
218 return 0;
219}
220
231{
232 if (!nc->global_data)
233 return -1;
234
235 struct MuttWindow *win_ibar = nc->global_data;
236 win_ibar->actions |= WA_RECALC;
237 mutt_debug(LL_DEBUG5, "index done, request WA_RECALC\n");
238
239 return 0;
240}
241
245static int ibar_menu_observer(struct NotifyCallback *nc)
246{
247 if (nc->event_type != NT_MENU)
248 return 0;
249 if (!nc->global_data)
250 return -1;
251
252 struct MuttWindow *win_ibar = nc->global_data;
253 win_ibar->actions |= WA_RECALC;
254 mutt_debug(LL_DEBUG5, "menu done, request WA_RECALC\n");
255
256 return 0;
257}
258
263{
264 if (nc->event_type != NT_WINDOW)
265 return 0;
266 if (!nc->global_data)
267 return -1;
268
269 struct MuttWindow *win_ibar = nc->global_data;
270 struct EventWindow *ev_w = nc->event_data;
271 if (ev_w->win != win_ibar)
272 return 0;
273
275 {
276 win_ibar->actions |= WA_REPAINT;
277 mutt_debug(LL_DEBUG5, "window state done, request WA_REPAINT\n");
278 }
279 else if (nc->event_subtype == NT_WINDOW_DELETE)
280 {
281 struct MuttWindow *dlg = window_find_parent(win_ibar, WT_DLG_INDEX);
282 struct IndexSharedData *shared = dlg->wdata;
283
289
290 mutt_debug(LL_DEBUG5, "window delete done\n");
291 }
292
293 return 0;
294}
295
299static void ibar_data_free(struct MuttWindow *win, void **ptr)
300{
301 if (!ptr || !*ptr)
302 return;
303
304 struct IBarPrivateData *ibar_data = *ptr;
305
306 FREE(&ibar_data->status_format);
307 FREE(&ibar_data->ts_status_format);
308 FREE(&ibar_data->ts_icon_format);
309
310 FREE(ptr);
311}
312
320 struct IndexPrivateData *priv)
321{
322 struct IBarPrivateData *ibar_data = mutt_mem_calloc(1, sizeof(struct IBarPrivateData));
323
324 ibar_data->shared = shared;
325 ibar_data->priv = priv;
326
327 return ibar_data;
328}
329
337struct MuttWindow *ibar_new(struct MuttWindow *parent, struct IndexSharedData *shared,
338 struct IndexPrivateData *priv)
339{
343
344 win_ibar->wdata = ibar_data_new(shared, priv);
345 win_ibar->wdata_free = ibar_data_free;
346 win_ibar->recalc = ibar_recalc;
347 win_ibar->repaint = ibar_repaint;
348
354
355 return win_ibar;
356}
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:69
void mutt_color_observer_add(observer_t callback, void *global_data)
Add an observer.
Definition: notify.c:59
@ MT_COLOR_MAX
Definition: color.h:94
@ MT_COLOR_STATUS
Status bar (takes a pattern)
Definition: color.h:75
@ MT_COLOR_NORMAL
Plain text.
Definition: color.h:59
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:929
#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:245
static int ibar_window_observer(struct NotifyCallback *nc)
Notification that a Window has changed - Implements observer_t -.
Definition: ibar.c:262
static int ibar_config_observer(struct NotifyCallback *nc)
Notification that a Config Variable has changed - Implements observer_t -.
Definition: ibar.c:193
static int ibar_color_observer(struct NotifyCallback *nc)
Notification that a Color has changed - Implements observer_t -.
Definition: ibar.c:167
static int ibar_index_observer(struct NotifyCallback *nc)
Notification that the Index has changed - Implements observer_t -.
Definition: ibar.c:230
static int ibar_recalc(struct MuttWindow *win)
Recalculate the Window data - Implements MuttWindow::recalc() -.
Definition: ibar.c:90
static int ibar_repaint(struct MuttWindow *win)
Repaint the Window - Implements MuttWindow::repaint() -.
Definition: ibar.c:139
static void ibar_data_free(struct MuttWindow *win, void **ptr)
Free the private data - Implements MuttWindow::wdata_free() -.
Definition: ibar.c:299
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:319
struct MuttWindow * ibar_new(struct MuttWindow *parent, struct IndexSharedData *shared, struct IndexPrivateData *priv)
Create the Index Bar (status)
Definition: ibar.c:337
Data shared between Index, Pager and Sidebar.
@ LL_DEBUG5
Log at debug level 5.
Definition: logging2.h:47
void * mutt_mem_calloc(size_t nmemb, size_t size)
Allocate zeroed memory on the heap.
Definition: memory.c:51
#define FREE(x)
Definition: memory.h:45
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:557
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:181
int mutt_window_move(struct MuttWindow *win, int col, int row)
Move the cursor in a Window.
Definition: mutt_window.c:296
void mutt_window_clrtoeol(struct MuttWindow *win)
Clear to the end of the line.
Definition: mutt_window.c:243
#define WA_RECALC
Recalculate the contents of the Window.
Definition: mutt_window.h:109
@ WT_DLG_INDEX
Index Dialog, dlg_index()
Definition: mutt_window.h:86
@ WT_STATUS_BAR
Status Bar containing extra info about the Index/Pager/etc.
Definition: mutt_window.h:101
@ MUTT_WIN_ORIENT_VERTICAL
Window uses all available vertical space.
Definition: mutt_window.h:38
@ NT_WINDOW_STATE
Window state has changed, e.g. WN_VISIBLE.
Definition: mutt_window.h:229
@ NT_WINDOW_DELETE
Window is about to be deleted.
Definition: mutt_window.h:228
#define WA_REPAINT
Redraw the contents of the Window.
Definition: mutt_window.h:110
#define MUTT_WIN_SIZE_UNLIMITED
Use as much space as possible.
Definition: mutt_window.h:52
@ MUTT_WIN_SIZE_FIXED
Window has a fixed size.
Definition: mutt_window.h:47
@ 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:81
void buf_pool_release(struct Buffer **ptr)
Return a Buffer to the pool.
Definition: pool.c:94
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:496
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:53
enum ColorId cid
Colour ID that has changed.
Definition: notify2.h:54
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:238
struct MuttWindow * win
Window that changed.
Definition: mutt_window.h:239
Parsed Expando trees.
Definition: expando.h:41
Data to draw the Index Bar.
Definition: ibar.c:79
char * ts_icon_format
Cached terminal icon string.
Definition: ibar.c:84
struct IndexSharedData * shared
Shared Index data.
Definition: ibar.c:80
char * ts_status_format
Cached terminal status string.
Definition: ibar.c:83
char * status_format
Cached screen status string.
Definition: ibar.c:82
struct IndexPrivateData * priv
Private Index data.
Definition: ibar.c:81
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:186
struct WindowState state
Current state of the Window.
Definition: mutt_window.h:126
void * wdata
Private data.
Definition: mutt_window.h:144
struct Notify * notify
Notifications: NotifyWindow, EventWindow.
Definition: mutt_window.h:137
int(* recalc)(struct MuttWindow *win)
Definition: mutt_window.h:172
void(* wdata_free)(struct MuttWindow *win, void **ptr)
Definition: mutt_window.h:158
struct MuttWindow * parent
Parent Window.
Definition: mutt_window.h:134
WindowActionFlags actions
Actions to be performed, e.g. WA_RECALC.
Definition: mutt_window.h:131
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:60
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