NeoMutt  2024-03-23-142-g2b2e76
Teaching an old dog new tricks
DOXYGEN
Loading...
Searching...
No Matches
sort.c File Reference

Assorted sorting methods. More...

#include "config.h"
#include <stdbool.h>
#include <stdlib.h>
#include "mutt/lib.h"
#include "address/lib.h"
#include "config/lib.h"
#include "email/lib.h"
#include "core/lib.h"
#include "alias/lib.h"
#include "sort.h"
#include "nntp/lib.h"
#include "globals.h"
#include "mutt_logging.h"
#include "mutt_thread.h"
#include "mview.h"
#include "mx.h"
#include "score.h"
+ Include dependency graph for sort.c:

Go to the source code of this file.

Data Structures

struct  EmailCompare
 Context for compare_email_shim() More...
 

Functions

static int compare_email_shim (const void *a, const void *b, void *sdata)
 Helper to sort emails - Implements sort_t -.
 
static int compare_score (const struct Email *a, const struct Email *b, bool reverse)
 Compare two emails using their scores - Implements sort_mail_t -.
 
static int compare_size (const struct Email *a, const struct Email *b, bool reverse)
 Compare the size of two emails - Implements sort_mail_t -.
 
static int compare_date_sent (const struct Email *a, const struct Email *b, bool reverse)
 Compare the sent date of two emails - Implements sort_mail_t -.
 
static int compare_subject (const struct Email *a, const struct Email *b, bool reverse)
 Compare the subject of two emails - Implements sort_mail_t -.
 
const char * mutt_get_name (const struct Address *a)
 Pick the best name to display from an address.
 
static int compare_to (const struct Email *a, const struct Email *b, bool reverse)
 Compare the 'to' fields of two emails - Implements sort_mail_t -.
 
static int compare_from (const struct Email *a, const struct Email *b, bool reverse)
 Compare the 'from' fields of two emails - Implements sort_mail_t -.
 
static int compare_date_received (const struct Email *a, const struct Email *b, bool reverse)
 Compare the date received of two emails - Implements sort_mail_t -.
 
static int compare_order (const struct Email *a, const struct Email *b, bool reverse)
 Restore the 'unsorted' order of emails - Implements sort_mail_t -.
 
static int compare_spam (const struct Email *a, const struct Email *b, bool reverse)
 Compare the spam values of two emails - Implements sort_mail_t -.
 
static int compare_label (const struct Email *a, const struct Email *b, bool reverse)
 Compare the labels of two emails - Implements sort_mail_t -.
 
static sort_mail_t get_sort_func (enum SortType method, enum MailboxType type)
 Get the sort function for a given sort id.
 
int mutt_compare_emails (const struct Email *a, const struct Email *b, enum MailboxType type, short sort, short sort_aux)
 Compare two emails using up to two sort methods -.
 
void mutt_sort_headers (struct MailboxView *mv, bool init)
 Sort emails by their headers.
 
void mutt_sort_order (struct Mailbox *m)
 Sort emails by their disk order.
 

Detailed Description

Assorted sorting methods.

Authors
  • Michael R. Elkins
  • Richard Russon
  • Pietro Cerutti
  • R Primus
  • Eric Blake

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.

Definition in file sort.c.

Function Documentation

◆ mutt_get_name()

const char * mutt_get_name ( const struct Address a)

Pick the best name to display from an address.

Parameters
aAddress to use
Return values
ptrDisplay name

This function uses:

  1. Alias for email address
  2. Personal name
  3. Email address

Definition at line 134 of file sort.c.

135{
136 struct Address *ali = NULL;
137
138 if (a)
139 {
140 const bool c_reverse_alias = cs_subset_bool(NeoMutt->sub, "reverse_alias");
141 if (c_reverse_alias && (ali = alias_reverse_lookup(a)) && ali->personal)
142 return buf_string(ali->personal);
143 if (a->personal)
144 return buf_string(a->personal);
145 if (a->mailbox)
146 return mutt_addr_for_display(a);
147 }
148 /* don't return NULL to avoid segfault when printing/comparing */
149 return "";
150}
const char * mutt_addr_for_display(const struct Address *a)
Convert an Address for display purposes.
Definition: address.c:1012
struct Address * alias_reverse_lookup(const struct Address *addr)
Does the user have an alias for the given address.
Definition: reverse.c:105
static const char * buf_string(const struct Buffer *buf)
Convert a buffer to a const char * "string".
Definition: buffer.h:96
bool cs_subset_bool(const struct ConfigSubset *sub, const char *name)
Get a boolean config item by name.
Definition: helpers.c:48
An email address.
Definition: address.h:36
struct Buffer * personal
Real name of address.
Definition: address.h:37
struct Buffer * mailbox
Mailbox and host address.
Definition: address.h:38
Container for Accounts, Notifications.
Definition: neomutt.h:41
struct ConfigSubset * sub
Inherited config items.
Definition: neomutt.h:45
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ get_sort_func()

static sort_mail_t get_sort_func ( enum SortType  method,
enum MailboxType  type 
)
static

Get the sort function for a given sort id.

Parameters
methodSort type, see SortType
typeThe Mailbox type
Return values
ptrsort function - Implements sort_mail_t

Definition at line 279 of file sort.c.

280{
281 switch (method)
282 {
283 case SORT_DATE:
284 return compare_date_sent;
285 case SORT_FROM:
286 return compare_from;
287 case SORT_LABEL:
288 return compare_label;
289 case SORT_ORDER:
290 if (type == MUTT_NNTP)
291 return nntp_compare_order;
292 else
293 return compare_order;
294 case SORT_RECEIVED:
296 case SORT_SCORE:
297 return compare_score;
298 case SORT_SIZE:
299 return compare_size;
300 case SORT_SPAM:
301 return compare_spam;
302 case SORT_SUBJECT:
303 return compare_subject;
304 case SORT_TO:
305 return compare_to;
306 default:
307 mutt_error(_("Could not find sorting function [report this bug]"));
308 return NULL;
309 }
310 /* not reached */
311}
@ MUTT_NNTP
'NNTP' (Usenet) Mailbox type
Definition: mailbox.h:49
#define mutt_error(...)
Definition: logging2.h:92
static int compare_to(const struct Email *a, const struct Email *b, bool reverse)
Compare the 'to' fields of two emails - Implements sort_mail_t -.
Definition: sort.c:155
int nntp_compare_order(const struct Email *a, const struct Email *b, bool reverse)
Restore the 'unsorted' order of emails - Implements sort_mail_t -.
Definition: nntp.c:2308
static int compare_label(const struct Email *a, const struct Email *b, bool reverse)
Compare the labels of two emails - Implements sort_mail_t -.
Definition: sort.c:248
static int compare_spam(const struct Email *a, const struct Email *b, bool reverse)
Compare the spam values of two emails - Implements sort_mail_t -.
Definition: sort.c:199
static int compare_order(const struct Email *a, const struct Email *b, bool reverse)
Restore the 'unsorted' order of emails - Implements sort_mail_t -.
Definition: sort.c:190
static int compare_date_sent(const struct Email *a, const struct Email *b, bool reverse)
Compare the sent date of two emails - Implements sort_mail_t -.
Definition: sort.c:93
static int compare_subject(const struct Email *a, const struct Email *b, bool reverse)
Compare the subject of two emails - Implements sort_mail_t -.
Definition: sort.c:102
static int compare_score(const struct Email *a, const struct Email *b, bool reverse)
Compare two emails using their scores - Implements sort_mail_t -.
Definition: sort.c:75
static int compare_from(const struct Email *a, const struct Email *b, bool reverse)
Compare the 'from' fields of two emails - Implements sort_mail_t -.
Definition: sort.c:168
static int compare_size(const struct Email *a, const struct Email *b, bool reverse)
Compare the size of two emails - Implements sort_mail_t -.
Definition: sort.c:84
static int compare_date_received(const struct Email *a, const struct Email *b, bool reverse)
Compare the date received of two emails - Implements sort_mail_t -.
Definition: sort.c:181
#define _(a)
Definition: message.h:28
@ SORT_SUBJECT
Sort by the email's subject.
Definition: sort2.h:38
@ SORT_ORDER
Sort by the order the messages appear in the mailbox.
Definition: sort2.h:40
@ SORT_SPAM
Sort by the email's spam score.
Definition: sort2.h:49
@ SORT_LABEL
Sort by the emails label.
Definition: sort2.h:54
@ SORT_FROM
Sort by the email's From field.
Definition: sort2.h:39
@ SORT_SIZE
Sort by the size of the email.
Definition: sort2.h:36
@ SORT_RECEIVED
Sort by when the message were delivered locally.
Definition: sort2.h:42
@ SORT_TO
Sort by the email's To field.
Definition: sort2.h:43
@ SORT_DATE
Sort by the date the email was sent.
Definition: sort2.h:35
@ SORT_SCORE
Sort by the email's score.
Definition: sort2.h:44
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mutt_sort_headers()

void mutt_sort_headers ( struct MailboxView mv,
bool  init 
)

Sort emails by their headers.

Parameters
mvMailbox View
initIf true, rebuild the thread

Definition at line 350 of file sort.c.

351{
352 if (!mv)
353 return;
354
355 struct Mailbox *m = mv->mailbox;
356 if (!m || !m->emails[0])
357 return;
358
359 OptNeedResort = false;
360
361 if (m->msg_count == 0)
362 {
363 /* this function gets called by mutt_sync_mailbox(), which may have just
364 * deleted all the messages. the virtual message numbers are not updated
365 * in that routine, so we must make sure to zero the vcount member. */
366 m->vcount = 0;
368 mv->vsize = 0;
369 return; /* nothing to do! */
370 }
371
372 if (m->verbose)
373 mutt_message(_("Sorting mailbox..."));
374
375 const bool c_score = cs_subset_bool(NeoMutt->sub, "score");
376 if (OptNeedRescore && c_score)
377 {
378 for (int i = 0; i < m->msg_count; i++)
379 {
380 struct Email *e = m->emails[i];
381 if (!e)
382 break;
383 mutt_score_message(m, e, true);
384 }
385 }
386 OptNeedRescore = false;
387
388 if (OptResortInit)
389 {
390 OptResortInit = false;
391 init = true;
392 }
393
394 if (init)
396
397 const bool threaded = mutt_using_threads();
398 if (threaded)
399 {
400 mutt_sort_threads(mv->threads, init);
401 }
402 else
403 {
404 struct EmailCompare cmp = { 0 };
405 cmp.type = mx_type(m);
406 cmp.sort = cs_subset_sort(NeoMutt->sub, "sort");
407 cmp.sort_aux = cs_subset_sort(NeoMutt->sub, "sort_aux");
408 mutt_qsort_r((void *) m->emails, m->msg_count, sizeof(struct Email *),
409 compare_email_shim, &cmp);
410 }
411
412 /* adjust the virtual message numbers */
413 m->vcount = 0;
414 for (int i = 0; i < m->msg_count; i++)
415 {
416 struct Email *e_cur = m->emails[i];
417 if (!e_cur)
418 break;
419
420 if ((e_cur->vnum != -1) || (e_cur->collapsed && e_cur->visible))
421 {
422 e_cur->vnum = m->vcount;
423 m->v2r[m->vcount] = i;
424 m->vcount++;
425 }
426 e_cur->msgno = i;
427 }
428
429 /* re-collapse threads marked as collapsed */
430 if (threaded)
431 {
433 mv->vsize = mutt_set_vnum(m);
434 }
435
436 if (m->verbose)
438}
short cs_subset_sort(const struct ConfigSubset *sub, const char *name)
Get a sort config item by name.
Definition: helpers.c:267
bool OptNeedRescore
(pseudo) set when the 'score' command is used
Definition: globals.c:68
bool OptResortInit
(pseudo) used to force the next resort to be from scratch
Definition: globals.c:74
bool OptNeedResort
(pseudo) used to force a re-sort
Definition: globals.c:69
#define mutt_message(...)
Definition: logging2.h:91
static int compare_email_shim(const void *a, const void *b, void *sdata)
Helper to sort emails - Implements sort_t -.
Definition: sort.c:64
void mutt_clear_error(void)
Clear the message line (bottom line of screen)
Definition: mutt_logging.c:74
void mutt_clear_threads(struct ThreadsContext *tctx)
Clear the threading of message in a mailbox.
Definition: mutt_thread.c:721
void mutt_thread_collapse_collapsed(struct ThreadsContext *tctx)
Re-collapse threads marked as collapsed.
Definition: mutt_thread.c:1769
void mutt_sort_threads(struct ThreadsContext *tctx, bool init)
Sort email threads.
Definition: mutt_thread.c:1032
off_t mutt_set_vnum(struct Mailbox *m)
Set the virtual index number of all the messages in a mailbox.
Definition: mutt_thread.c:1405
#define mutt_using_threads()
Definition: mutt_thread.h:114
enum MailboxType mx_type(struct Mailbox *m)
Return the type of the Mailbox.
Definition: mx.c:1794
void mutt_qsort_r(void *base, size_t nmemb, size_t size, sort_t compar, void *sdata)
Sort an array, where the comparator has access to opaque data rather than requiring global variables.
Definition: qsort_r.c:67
void mutt_score_message(struct Mailbox *m, struct Email *e, bool upd_mbox)
Apply scoring to an email.
Definition: score.c:164
Context for compare_email_shim()
Definition: sort.c:55
short sort_aux
Secondary sort.
Definition: sort.c:58
short sort
Primary sort.
Definition: sort.c:57
enum MailboxType type
Current mailbox type.
Definition: sort.c:56
The envelope/body of an email.
Definition: email.h:39
bool visible
Is this message part of the view?
Definition: email.h:124
bool collapsed
Is this message part of a collapsed thread?
Definition: email.h:123
bool threaded
Used for threading.
Definition: email.h:111
int vnum
Virtual message number.
Definition: email.h:117
int msgno
Number displayed to the user.
Definition: email.h:114
off_t vsize
Size (in bytes) of the messages shown.
Definition: mview.h:41
struct ThreadsContext * threads
Threads context.
Definition: mview.h:44
struct Mailbox * mailbox
Current Mailbox.
Definition: mview.h:51
A mailbox.
Definition: mailbox.h:79
int vcount
The number of virtual messages.
Definition: mailbox.h:99
int * v2r
Mapping from virtual to real msgno.
Definition: mailbox.h:98
int msg_count
Total number of messages.
Definition: mailbox.h:88
struct Email ** emails
Array of Emails.
Definition: mailbox.h:96
bool verbose
Display status messages?
Definition: mailbox.h:117
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mutt_sort_order()

void mutt_sort_order ( struct Mailbox m)

Sort emails by their disk order.

Parameters
mMailbox

Definition at line 444 of file sort.c.

445{
446 if (!m)
447 return;
448
449 struct EmailCompare cmp = { 0 };
450 cmp.type = mx_type(m);
451 cmp.sort = SORT_ORDER;
452 mutt_qsort_r((void *) m->emails, m->msg_count, sizeof(struct Email *),
453 compare_email_shim, &cmp);
454}
+ Here is the call graph for this function:
+ Here is the caller graph for this function: