NeoMutt  2025-01-09-41-g086358
Teaching an old dog new tricks
DOXYGEN
Loading...
Searching...
No Matches
Alias Function API

Prototype for a Alias Function. More...

+ Collaboration diagram for Alias Function API:

Functions

static int op_create_alias (struct AliasMenuData *mdata, int op)
 create an alias from a message sender - Implements alias_function_t -
 
static int op_delete (struct AliasMenuData *mdata, int op)
 delete the current entry - Implements alias_function_t -
 
static int op_exit (struct AliasMenuData *mdata, int op)
 exit this menu - Implements alias_function_t -
 
static int op_generic_select_entry (struct AliasMenuData *mdata, int op)
 select the current entry - Implements alias_function_t -
 
static int op_main_limit (struct AliasMenuData *mdata, int op)
 show only messages matching a pattern - Implements alias_function_t -
 
static int op_main_tag_pattern (struct AliasMenuData *mdata, int op)
 Tag messages matching a pattern - Implements alias_function_t -.
 
static int op_main_untag_pattern (struct AliasMenuData *mdata, int op)
 Untag messages matching a pattern - Implements alias_function_t -.
 
static int op_query (struct AliasMenuData *mdata, int op)
 query external program for addresses - Implements alias_function_t -
 
static int op_search (struct AliasMenuData *mdata, int op)
 search for a regular expression - Implements alias_function_t -
 
static int op_sort (struct AliasMenuData *mdata, int op)
 sort aliases - Implements alias_function_t -
 

Detailed Description

Prototype for a Alias Function.

Parameters
wdataAlias Window data
opOperation to perform, e.g. OP_ALIAS_NEXT
Return values
enumFunctionRetval

Function Documentation

◆ op_create_alias()

static int op_create_alias ( struct AliasMenuData mdata,
int  op 
)
static

create an alias from a message sender - Implements alias_function_t -

Definition at line 129 of file functions.c.

130{
131 struct Menu *menu = mdata->menu;
132
133 if (menu->tag_prefix)
134 {
135 struct AddressList naddr = TAILQ_HEAD_INITIALIZER(naddr);
136
137 struct AliasView *avp = NULL;
138 ARRAY_FOREACH(avp, &mdata->ava)
139 {
140 if (!avp->is_tagged)
141 continue;
142
143 struct AddressList al = TAILQ_HEAD_INITIALIZER(al);
144 if (alias_to_addrlist(&al, avp->alias))
145 {
146 mutt_addrlist_copy(&naddr, &al, false);
148 }
149 }
150
151 alias_create(&naddr, mdata->sub);
152 mutt_addrlist_clear(&naddr);
153 }
154 else
155 {
156 struct AddressList al = TAILQ_HEAD_INITIALIZER(al);
157 if (alias_to_addrlist(&al, ARRAY_GET(&mdata->ava, menu_get_index(menu))->alias))
158 {
159 alias_create(&al, mdata->sub);
161 }
162 }
163 return FR_SUCCESS;
164}
void mutt_addrlist_copy(struct AddressList *dst, const struct AddressList *src, bool prune)
Copy a list of addresses into another list.
Definition: address.c:765
void mutt_addrlist_clear(struct AddressList *al)
Unlink and free all Address in an AddressList.
Definition: address.c:1460
void alias_create(struct AddressList *al, const struct ConfigSubset *sub)
Create a new Alias from an Address.
Definition: alias.c:367
#define ARRAY_FOREACH(elem, head)
Iterate over all elements of the array.
Definition: array.h:212
#define ARRAY_GET(head, idx)
Return the element at index.
Definition: array.h:109
@ FR_SUCCESS
Valid function - successfully performed.
Definition: dispatcher.h:39
bool alias_to_addrlist(struct AddressList *al, struct Alias *alias)
Turn an Alias into an AddressList.
Definition: dlg_query.c:120
int menu_get_index(struct Menu *menu)
Get the current selection in the Menu.
Definition: menu.c:160
#define TAILQ_HEAD_INITIALIZER(head)
Definition: queue.h:694
struct AliasViewArray ava
All Aliases/Queries.
Definition: gui.h:55
struct ConfigSubset * sub
Config items.
Definition: gui.h:57
GUI data wrapping an Alias.
Definition: gui.h:38
struct Alias * alias
Alias.
Definition: gui.h:46
bool is_tagged
Is it tagged?
Definition: gui.h:43
Definition: lib.h:79
void * mdata
Private data.
Definition: lib.h:147
bool tag_prefix
User has pressed <tag-prefix>
Definition: lib.h:85
+ Here is the call graph for this function:

◆ op_delete()

static int op_delete ( struct AliasMenuData mdata,
int  op 
)
static

delete the current entry - Implements alias_function_t -

Definition at line 169 of file functions.c.

170{
171 struct Menu *menu = mdata->menu;
172
173 if (menu->tag_prefix)
174 {
175 struct AliasView *avp = NULL;
176 ARRAY_FOREACH(avp, &mdata->ava)
177 {
178 if (avp->is_tagged)
179 avp->is_deleted = (op == OP_DELETE);
180 }
182 }
183 else
184 {
185 int index = menu_get_index(menu);
186 ARRAY_GET(&mdata->ava, index)->is_deleted = (op == OP_DELETE);
188 const bool c_resolve = cs_subset_bool(mdata->sub, "resolve");
189 if (c_resolve && (index < (menu->max - 1)))
190 {
191 menu_set_index(menu, index + 1);
193 }
194 }
195 return FR_SUCCESS;
196}
bool cs_subset_bool(const struct ConfigSubset *sub, const char *name)
Get a boolean config item by name.
Definition: helpers.c:47
#define MENU_REDRAW_INDEX
Redraw the index.
Definition: lib.h:56
void menu_queue_redraw(struct Menu *menu, MenuRedrawFlags redraw)
Queue a request for a redraw.
Definition: menu.c:184
#define MENU_REDRAW_CURRENT
Redraw the current line of the menu.
Definition: lib.h:58
MenuRedrawFlags menu_set_index(struct Menu *menu, int index)
Set the current selection in the Menu.
Definition: menu.c:174
bool is_deleted
Is it deleted?
Definition: gui.h:44
int max
Number of entries in the menu.
Definition: lib.h:81
+ Here is the call graph for this function:

◆ op_exit()

static int op_exit ( struct AliasMenuData mdata,
int  op 
)
static

exit this menu - Implements alias_function_t -

Definition at line 201 of file functions.c.

202{
203 return FR_DONE;
204}
@ FR_DONE
Exit the Dialog.
Definition: dispatcher.h:35
+ Here is the caller graph for this function:

◆ op_generic_select_entry()

static int op_generic_select_entry ( struct AliasMenuData mdata,
int  op 
)
static

select the current entry - Implements alias_function_t -

This function handles:

  • OP_GENERIC_SELECT_ENTRY
  • OP_MAIL
Note
AliasMenuData.is_tagged will show the user's selection

Definition at line 215 of file functions.c.

216{
217 struct Menu *menu = mdata->menu;
218 if (menu->tag_prefix)
219 {
220 // Untag any non-visible aliases
221 struct AliasView *avp = NULL;
222 ARRAY_FOREACH(avp, &mdata->ava)
223 {
224 if (avp->is_tagged && !avp->is_visible)
225 avp->is_tagged = false;
226 }
227 }
228 else
229 {
230 // Untag all but the current alias
231 struct AliasView *avp = NULL;
232 const int idx = menu_get_index(menu);
233 ARRAY_FOREACH(avp, &mdata->ava)
234 {
235 avp->is_tagged = (ARRAY_FOREACH_IDX_avp == idx);
236 }
237 }
238
239 return FR_CONTINUE;
240}
@ FR_CONTINUE
Remain in the Dialog.
Definition: dispatcher.h:34
bool is_visible
Is visible?
Definition: gui.h:45
+ Here is the call graph for this function:

◆ op_main_limit()

static int op_main_limit ( struct AliasMenuData mdata,
int  op 
)
static

show only messages matching a pattern - Implements alias_function_t -

Definition at line 245 of file functions.c.

246{
247 struct Menu *menu = mdata->menu;
248 int rc = mutt_pattern_alias_func(_("Limit to addresses matching: "), mdata,
249 PAA_VISIBLE, menu);
250 if (rc != 0)
251 return FR_NO_ACTION;
252
253 alias_array_sort(&mdata->ava, mdata->sub);
254 alias_set_title(mdata->sbar, mdata->title, mdata->limit);
256 window_redraw(NULL);
257
258 return FR_SUCCESS;
259}
void alias_array_sort(struct AliasViewArray *ava, const struct ConfigSubset *sub)
Sort and reindex an AliasViewArray.
Definition: sort.c:235
@ FR_NO_ACTION
Valid function - no action performed.
Definition: dispatcher.h:37
void alias_set_title(struct MuttWindow *sbar, char *menu_name, char *limit)
Create a title string for the Menu.
Definition: gui.c:72
#define MENU_REDRAW_FULL
Redraw everything.
Definition: lib.h:59
#define _(a)
Definition: message.h:28
void window_redraw(struct MuttWindow *win)
Reflow, recalc and repaint a tree of Windows.
Definition: mutt_window.c:596
@ PAA_VISIBLE
Set AliasView.is_visible and hide the rest.
Definition: lib.h:190
int mutt_pattern_alias_func(char *prompt, struct AliasMenuData *mdata, enum PatternAlias action, struct Menu *menu)
Perform some Pattern matching for Alias.
Definition: pattern.c:191
+ Here is the call graph for this function:

◆ op_main_tag_pattern()

static int op_main_tag_pattern ( struct AliasMenuData mdata,
int  op 
)
static

Tag messages matching a pattern - Implements alias_function_t -.

Definition at line 264 of file functions.c.

265{
266 struct Menu *menu = mdata->menu;
267 int rc = mutt_pattern_alias_func(_("Tag addresses matching: "), mdata, PAA_TAG, menu);
268 if (rc != 0)
269 return FR_NO_ACTION;
270
272 window_redraw(NULL);
273
274 return FR_SUCCESS;
275}
@ PAA_TAG
Set AliasView.is_tagged, but don't touch the others.
Definition: lib.h:188
+ Here is the call graph for this function:

◆ op_main_untag_pattern()

static int op_main_untag_pattern ( struct AliasMenuData mdata,
int  op 
)
static

Untag messages matching a pattern - Implements alias_function_t -.

Definition at line 280 of file functions.c.

281{
282 struct Menu *menu = mdata->menu;
283 int rc = mutt_pattern_alias_func(_("Untag addresses matching: "), mdata, PAA_UNTAG, menu);
284 if (rc != 0)
285 return FR_NO_ACTION;
286
288 window_redraw(NULL);
289
290 return FR_SUCCESS;
291}
@ PAA_UNTAG
Unset AliasView.is_tagged, but don't touch the others.
Definition: lib.h:189
+ Here is the call graph for this function:

◆ op_query()

static int op_query ( struct AliasMenuData mdata,
int  op 
)
static

query external program for addresses - Implements alias_function_t -

This function handles:

  • OP_QUERY
  • OP_QUERY_APPEND

Definition at line 300 of file functions.c.

301{
302 struct Buffer *buf = mdata->query;
303 if ((mw_get_field(_("Query: "), buf, MUTT_COMP_NO_FLAGS, HC_OTHER, NULL, NULL) != 0) ||
304 buf_is_empty(buf))
305 {
306 return FR_NO_ACTION;
307 }
308
309 if (op == OP_QUERY)
310 {
311 ARRAY_FREE(&mdata->ava);
312 aliaslist_clear(mdata->al);
313 }
314
315 struct Menu *menu = mdata->menu;
316 struct AliasList al = TAILQ_HEAD_INITIALIZER(al);
317
318 query_run(buf_string(buf), true, &al, mdata->sub);
320 char title[256] = { 0 };
321 snprintf(title, sizeof(title), "%s%s", _("Query: "), buf_string(buf));
322 sbar_set_title(mdata->sbar, title);
323
324 if (TAILQ_EMPTY(&al))
325 {
326 if (op == OP_QUERY)
327 menu->max = 0;
328 return FR_NO_ACTION;
329 }
330
331 struct Alias *np = NULL;
332 struct Alias *tmp = NULL;
333 TAILQ_FOREACH_SAFE(np, &al, entries, tmp)
334 {
335 alias_array_alias_add(&mdata->ava, np);
336 TAILQ_REMOVE(&al, np, entries);
337 TAILQ_INSERT_TAIL(mdata->al, np, entries); // Transfer
338 }
339 alias_array_sort(&mdata->ava, mdata->sub);
340 menu->max = ARRAY_SIZE(&mdata->ava);
341 return FR_SUCCESS;
342}
void aliaslist_clear(struct AliasList *al)
Empty a List of Aliases.
Definition: alias.c:693
int alias_array_alias_add(struct AliasViewArray *ava, struct Alias *alias)
Add an Alias to the AliasViewArray.
Definition: array.c:47
#define ARRAY_SIZE(head)
The number of elements stored.
Definition: array.h:87
#define ARRAY_FREE(head)
Release all memory.
Definition: array.h:204
bool buf_is_empty(const struct Buffer *buf)
Is the Buffer empty?
Definition: buffer.c:291
static const char * buf_string(const struct Buffer *buf)
Convert a buffer to a const char * "string".
Definition: buffer.h:96
int query_run(const char *s, bool verbose, struct AliasList *al, const struct ConfigSubset *sub)
Run an external program to find Addresses.
Definition: dlg_query.c:189
int mw_get_field(const char *prompt, struct Buffer *buf, CompletionFlags complete, enum HistoryClass hclass, const struct CompleteOps *comp_api, void *cdata)
Ask the user for a string -.
Definition: window.c:273
@ HC_OTHER
Miscellaneous strings.
Definition: lib.h:58
#define MUTT_COMP_NO_FLAGS
No flags are set.
Definition: mutt.h:56
#define TAILQ_FOREACH_SAFE(var, head, field, tvar)
Definition: queue.h:792
#define TAILQ_INSERT_TAIL(head, elm, field)
Definition: queue.h:866
#define TAILQ_REMOVE(head, elm, field)
Definition: queue.h:901
#define TAILQ_EMPTY(head)
Definition: queue.h:778
void sbar_set_title(struct MuttWindow *win, const char *title)
Set the title for the Simple Bar.
Definition: sbar.c:227
struct MuttWindow * sbar
Status Bar.
Definition: gui.h:61
struct Buffer * query
Query string.
Definition: gui.h:59
struct AliasList * al
Alias data.
Definition: gui.h:56
A shortcut for an email address or addresses.
Definition: alias.h:35
String manipulation buffer.
Definition: buffer.h:36
+ Here is the call graph for this function:

◆ op_search()

static int op_search ( struct AliasMenuData mdata,
int  op 
)
static

search for a regular expression - Implements alias_function_t -

This function handles:

  • OP_SEARCH
  • OP_SEARCH_NEXT
  • OP_SEARCH_OPPOSITE
  • OP_SEARCH_REVERSE

Definition at line 353 of file functions.c.

354{
356 switch (op)
357 {
358 case OP_SEARCH:
359 flags |= SEARCH_PROMPT;
360 mdata->search_state->reverse = false;
361 break;
362 case OP_SEARCH_REVERSE:
363 flags |= SEARCH_PROMPT;
364 mdata->search_state->reverse = true;
365 break;
366 case OP_SEARCH_NEXT:
367 break;
368 case OP_SEARCH_OPPOSITE:
369 flags |= SEARCH_OPPOSITE;
370 break;
371 }
372
373 struct Menu *menu = mdata->menu;
374 int index = menu_get_index(menu);
375 index = mutt_search_alias_command(menu, index, mdata->search_state, flags);
376 if (index == -1)
377 return FR_NO_ACTION;
378
379 menu_set_index(menu, index);
380 return FR_SUCCESS;
381}
int mutt_search_alias_command(struct Menu *menu, int cur, struct SearchState *state, SearchFlags flags)
Perform a search.
Definition: pattern.c:636
#define SEARCH_OPPOSITE
Search in the opposite direction.
Definition: search_state.h:46
uint8_t SearchFlags
Flags for a specific search, e.g. SEARCH_PROMPT.
Definition: search_state.h:43
#define SEARCH_NO_FLAGS
No flags are set.
Definition: search_state.h:44
#define SEARCH_PROMPT
Ask for search input.
Definition: search_state.h:45
struct SearchState * search_state
State of the current search.
Definition: gui.h:63
bool reverse
search backwards
Definition: search_state.h:40
+ Here is the call graph for this function:

◆ op_sort()

static int op_sort ( struct AliasMenuData mdata,
int  op 
)
static

sort aliases - Implements alias_function_t -

This function handles:

  • OP_SORT
  • OP_SORT_REVERSE

Definition at line 390 of file functions.c.

391{
392 int sort = cs_subset_sort(mdata->sub, "alias_sort");
393 bool resort = true;
394 bool reverse = (op == OP_SORT_REVERSE);
395
396 switch (mw_multi_choice(reverse ?
397 /* L10N: The highlighted letters must match the "Sort" options */
398 _("Rev-Sort (a)lias, (n)ame, (e)mail or (u)nsorted?") :
399 /* L10N: The highlighted letters must match the "Rev-Sort" options */
400 _("Sort (a)lias, (n)ame, (e)mail or (u)nsorted?"),
401 /* L10N: These must match the highlighted letters from "Sort" and "Rev-Sort" */
402 _("aneu")))
403 {
404 case -1: /* abort */
405 resort = false;
406 break;
407
408 case 1: /* (a)lias */
409 sort = ALIAS_SORT_ALIAS;
410 break;
411
412 case 2: /* (n)ame */
413 sort = ALIAS_SORT_NAME;
414 break;
415
416 case 3: /* (e)mail */
417 sort = ALIAS_SORT_EMAIL;
418 break;
419
420 case 4: /* (u)nsorted */
421 sort = ALIAS_SORT_UNSORTED;
422 break;
423 }
424
425 if (resort)
426 {
427 sort |= reverse ? SORT_REVERSE : 0;
428
429 // This will trigger a WA_RECALC
430 cs_subset_str_native_set(mdata->sub, "alias_sort", sort, NULL);
431 }
432
433 return FR_SUCCESS;
434}
@ ALIAS_SORT_UNSORTED
Sort by the order the Aliases were configured.
Definition: sort.h:34
@ ALIAS_SORT_NAME
Sort by Real Name.
Definition: sort.h:33
@ ALIAS_SORT_EMAIL
Sort by Email Address.
Definition: sort.h:32
@ ALIAS_SORT_ALIAS
Sort by Alias short name.
Definition: sort.h:31
short cs_subset_sort(const struct ConfigSubset *sub, const char *name)
Get a sort config item by name.
Definition: helpers.c:266
#define SORT_REVERSE
Reverse the order of the sort.
Definition: sort.h:39
int mw_multi_choice(const char *prompt, const char *letters)
Offer the user a multiple choice question -.
Definition: question.c:63
int cs_subset_str_native_set(const struct ConfigSubset *sub, const char *name, intptr_t value, struct Buffer *err)
Natively set the value of a string config item.
Definition: subset.c:297
+ Here is the call graph for this function: