NeoMutt  2024-02-01-23-g345d7b
Teaching an old dog new tricks
DOXYGEN
Loading...
Searching...
No Matches
sidebar.c
Go to the documentation of this file.
1
32#include "config.h"
33#include <stdbool.h>
34#include <stdio.h>
35#include "private.h"
36#include "mutt/lib.h"
37#include "config/lib.h"
38#include "core/lib.h"
39#include "gui/lib.h"
40#include "lib.h"
41#include "index/lib.h"
42
44
48static const struct Command SbCommands[] = {
49 // clang-format off
50 { "sidebar_pin", sb_parse_sidebar_pin, 0 },
51 { "sidebar_unpin", sb_parse_sidebar_unpin, 0 },
52
53 { "sidebar_whitelist", sb_parse_sidebar_pin, 0 },
54 { "unsidebar_whitelist", sb_parse_sidebar_unpin, 0 },
55 // clang-format on
56};
57
64{
65 const bool c_sidebar_visible = cs_subset_bool(NeoMutt->sub, "sidebar_visible");
66 if (!c_sidebar_visible)
67 return NULL;
68
70 if (wdata->hil_index < 0)
71 return NULL;
72
73 struct SbEntry **sbep = ARRAY_GET(&wdata->entries, wdata->hil_index);
74 if (!sbep)
75 return NULL;
76
77 return (*sbep)->mailbox;
78}
79
88void sb_add_mailbox(struct SidebarWindowData *wdata, struct Mailbox *m)
89{
90 if (!m)
91 return;
92
93 struct SbEntry **sbep = NULL;
94 ARRAY_FOREACH(sbep, &wdata->entries)
95 {
96 if ((*sbep)->mailbox == m)
97 return;
98 }
99
100 /* Any new/deleted mailboxes will cause a refresh. As long as
101 * they're valid, our pointers will be updated in prepare_sidebar() */
102
103 struct IndexSharedData *shared = wdata->shared;
104 struct SbEntry *entry = mutt_mem_calloc(1, sizeof(struct SbEntry));
105 entry->mailbox = m;
106
107 if (wdata->top_index < 0)
108 wdata->top_index = ARRAY_SIZE(&wdata->entries);
109 if (wdata->bot_index < 0)
110 wdata->bot_index = ARRAY_SIZE(&wdata->entries);
111 if ((wdata->opn_index < 0) && shared->mailbox &&
113 {
114 wdata->opn_index = ARRAY_SIZE(&wdata->entries);
115 }
116
117 ARRAY_ADD(&wdata->entries, entry);
118}
119
125void sb_remove_mailbox(struct SidebarWindowData *wdata, const struct Mailbox *m)
126{
127 struct SbEntry **sbep = NULL;
128 ARRAY_FOREACH(sbep, &wdata->entries)
129 {
130 if ((*sbep)->mailbox != m)
131 continue;
132
133 struct SbEntry *sbe_remove = *sbep;
134 ARRAY_REMOVE(&wdata->entries, sbep);
135 FREE(&sbe_remove);
136
137 if (wdata->opn_index == ARRAY_FOREACH_IDX)
138 {
139 // Open item was deleted
140 wdata->opn_index = -1;
141 }
142 else if ((wdata->opn_index > 0) && (wdata->opn_index > ARRAY_FOREACH_IDX))
143 {
144 // Open item is still visible, so adjust the index
145 wdata->opn_index--;
146 }
147
148 if (wdata->hil_index == ARRAY_FOREACH_IDX)
149 {
150 // If possible, keep the highlight where it is
151 struct SbEntry **sbep_cur = ARRAY_GET(&wdata->entries, ARRAY_FOREACH_IDX);
152 if (!sbep_cur)
153 {
154 // The last entry was deleted, so backtrack
155 sb_prev(wdata);
156 }
157 else if ((*sbep)->is_hidden)
158 {
159 // Find the next unhidden entry, or the previous
160 if (!sb_next(wdata) && !sb_prev(wdata))
161 wdata->hil_index = -1;
162 }
163 }
164 else if ((wdata->hil_index > 0) && (wdata->hil_index > ARRAY_FOREACH_IDX))
165 {
166 // Highlighted item is still visible, so adjust the index
167 wdata->hil_index--;
168 }
169 break;
170 }
171}
172
179{
180 wdata->opn_index = -1;
181
182 struct SbEntry **sbep = NULL;
183 ARRAY_FOREACH(sbep, &wdata->entries)
184 {
185 if (m && m->visible)
186 {
187 if (mutt_str_equal((*sbep)->mailbox->realpath, m->realpath))
188 {
189 wdata->opn_index = ARRAY_FOREACH_IDX;
190 wdata->hil_index = ARRAY_FOREACH_IDX;
191 break;
192 }
193 }
194 (*sbep)->is_hidden = !(*sbep)->mailbox->visible;
195 }
196}
197
201void sb_init(void)
202{
204
205 // Listen for dialog creation events
208}
209
213void sb_cleanup(void)
214{
218}
#define ARRAY_ADD(head, elem)
Add an element at the end of the array.
Definition: array.h:156
#define ARRAY_REMOVE(head, elem)
Remove an entry from the array, shifting down the subsequent entries.
Definition: array.h:267
#define ARRAY_FOREACH(elem, head)
Iterate over all elements of the array.
Definition: array.h:212
#define ARRAY_SIZE(head)
The number of elements stored.
Definition: array.h:87
#define ARRAY_GET(head, idx)
Return the element at index.
Definition: array.h:109
bool cs_subset_bool(const struct ConfigSubset *sub, const char *name)
Get a boolean config item by name.
Definition: helpers.c:48
Convenience wrapper for the config headers.
void commands_register(const struct Command *cmds, const size_t num_cmds)
Add commands to Commands array.
Definition: command.c:53
Convenience wrapper for the core headers.
struct MuttWindow * AllDialogsWindow
Parent of all Dialogs.
Definition: dialog.c:80
enum CommandResult sb_parse_sidebar_pin(struct Buffer *buf, struct Buffer *s, intptr_t data, struct Buffer *err)
Parse the 'sidebar_pin' command - Implements Command::parse() -.
Definition: commands.c:41
enum CommandResult sb_parse_sidebar_unpin(struct Buffer *buf, struct Buffer *s, intptr_t data, struct Buffer *err)
Parse the 'sidebar_unpin' command - Implements Command::parse() -.
Definition: commands.c:60
int sb_insertion_window_observer(struct NotifyCallback *nc)
Notification that a Window has changed - Implements observer_t -.
Definition: observer.c:466
Convenience wrapper for the gui headers.
GUI manage the main index (list of emails)
void mutt_list_free(struct ListHead *h)
Free a List AND its strings.
Definition: list.c:122
void * mutt_mem_calloc(size_t nmemb, size_t size)
Allocate zeroed memory on the heap.
Definition: memory.c:50
#define FREE(x)
Definition: memory.h:45
#define mutt_array_size(x)
Definition: memory.h:38
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:709
@ NT_WINDOW
MuttWindow has changed, NotifyWindow, EventWindow.
Definition: notify_type.h:57
#define STAILQ_HEAD_INITIALIZER(head)
Definition: queue.h:324
bool sb_prev(struct SidebarWindowData *wdata)
Find the previous unhidden Mailbox.
Definition: functions.c:86
bool sb_next(struct SidebarWindowData *wdata)
Find the next unhidden Mailbox.
Definition: functions.c:47
GUI display the mailboxes in a side panel.
struct SidebarWindowData * sb_wdata_get(struct MuttWindow *win)
Get the Sidebar data for this window.
Definition: wdata.c:77
void sb_init(void)
Set up the Sidebar.
Definition: sidebar.c:201
static const struct Command SbCommands[]
Sidebar Commands.
Definition: sidebar.c:48
void sb_remove_mailbox(struct SidebarWindowData *wdata, const struct Mailbox *m)
Remove a Mailbox from the Sidebar.
Definition: sidebar.c:125
void sb_cleanup(void)
Clean up the Sidebar.
Definition: sidebar.c:213
void sb_set_current_mailbox(struct SidebarWindowData *wdata, struct Mailbox *m)
Set the current Mailbox.
Definition: sidebar.c:178
struct ListHead SidebarPinned
List of mailboxes to always display in the sidebar.
Definition: sidebar.c:43
void sb_add_mailbox(struct SidebarWindowData *wdata, struct Mailbox *m)
Add a Mailbox to the Sidebar.
Definition: sidebar.c:88
struct Mailbox * sb_get_highlight(struct MuttWindow *win)
Get the Mailbox that's highlighted in the sidebar.
Definition: sidebar.c:63
Key value store.
Data shared between Index, Pager and Sidebar.
Definition: shared_data.h:37
struct Mailbox * mailbox
Current Mailbox.
Definition: shared_data.h:41
A mailbox.
Definition: mailbox.h:79
char * realpath
Used for duplicate detection, context comparison, and the sidebar.
Definition: mailbox.h:81
bool visible
True if a result of "mailboxes".
Definition: mailbox.h:130
void * wdata
Private data.
Definition: mutt_window.h:145
struct Notify * notify
Notifications: NotifyWindow, EventWindow.
Definition: mutt_window.h:138
Container for Accounts, Notifications.
Definition: neomutt.h:41
struct ConfigSubset * sub
Inherited config items.
Definition: neomutt.h:45
Info about folders in the sidebar.
Definition: private.h:41
struct Mailbox * mailbox
Mailbox this represents.
Definition: private.h:45
Sidebar private Window data -.
Definition: private.h:64
int top_index
First mailbox visible in sidebar.
Definition: private.h:69
int bot_index
Last mailbox visible in sidebar.
Definition: private.h:72
int hil_index
Highlighted mailbox.
Definition: private.h:71
struct IndexSharedData * shared
Shared Index Data.
Definition: private.h:66
int opn_index
Current (open) mailbox.
Definition: private.h:70
struct MuttWindow * win
Sidebar Window.
Definition: private.h:65
struct SbEntryArray entries
Items to display in the sidebar.
Definition: private.h:67