Sorting API

Prototype for generic comparison function, compatible with qsort() More...

Functions
static int	alias_sort_name (const void *a, const void *b)
	Compare two Aliases by their short names - Implements sort_t -. More...
static int	alias_sort_address (const void *a, const void *b)
	Compare two Aliases by their Addresses - Implements sort_t -. More...
static int	alias_sort_unsort (const void *a, const void *b)
	Compare two Aliases by their original configuration position - Implements sort_t -. More...
static int	browser_compare_subject (const void *a, const void *b)
	Compare the subject of two browser entries - Implements sort_t -. More...
static int	browser_compare_order (const void *a, const void *b)
	Compare the order of creation of two browser entries - Implements sort_t -. More...
static int	browser_compare_desc (const void *a, const void *b)
	Compare the descriptions of two browser entries - Implements sort_t -. More...
static int	browser_compare_date (const void *a, const void *b)
	Compare the date of two browser entries - Implements sort_t -. More...
static int	browser_compare_size (const void *a, const void *b)
	Compare the size of two browser entries - Implements sort_t -. More...
static int	browser_compare_count (const void *a, const void *b)
	Compare the message count of two browser entries - Implements sort_t -. More...
static int	browser_compare_count_new (const void *a, const void *b)
	Compare the new count of two browser entries - Implements sort_t -. More...
static int	browser_compare (const void *a, const void *b)
	Sort the items in the browser - Implements sort_t -. More...
static int	commands_cmp (const void *a, const void *b)
	Compare two commands by name - Implements sort_t -. More...
static int	compare_uid (const void *a, const void *b)
	Compare two Emails by UID - Implements sort_t -. More...
static int	maildir_cmp_inode (const void *a, const void *b)
	Compare two Maildirs by inode number - Implements sort_t -. More...
static int	mh_cmp_path (const void *a, const void *b)
	Compare two Maildirs by path - Implements sort_t -. More...
static int	sb_sort_count (const void *a, const void *b)
	Sort Sidebar entries by count - Implements sort_t -. More...
static int	sb_sort_desc (const void *a, const void *b)
	Sort Sidebar entries by description - Implements sort_t -. More...
static int	sb_sort_flagged (const void *a, const void *b)
	Sort Sidebar entries by flagged - Implements sort_t -. More...
static int	sb_sort_path (const void *a, const void *b)
	Sort Sidebar entries by path - Implements sort_t -. More...
static int	sb_sort_unread (const void *a, const void *b)
	Sort Sidebar entries by unread - Implements sort_t -. More...
static int	sb_sort_order (const void *a, const void *b)
	Sort Sidebar entries by order of creation - Implements sort_t -. More...
static int	sb_sort_unsorted (const void *a, const void *b)
	Sort Sidebar entries into their original order - Implements sort_t -. More...

Detailed Description

Prototype for generic comparison function, compatible with qsort()

Parameters

a	First item
b	Second item

Return values

<0	a precedes b
0	a and b are identical
>0	b precedes a

Function Documentation

alias_sort_name()

static int alias_sort_name ( const void *  a, const void *  b  )

static

Compare two Aliases by their short names - Implements sort_t -.

Note

Non-visible Aliases are sorted to the end

Definition at line 47 of file sort.c.

{
  const struct AliasView *av_a = a;
  const struct AliasView *av_b = b;
 
  if (av_a->is_visible != av_b->is_visible)
    return av_a->is_visible ? -1 : 1;
 
  if (!av_a->is_visible)
    return 0;
 
  int r = mutt_str_coll(av_a->alias->name, av_b->alias->name);
 
  return RSORT(r);
}

Here is the call graph for this function:

Here is the caller graph for this function:

alias_sort_address()

static int alias_sort_address ( const void *  a, const void *  b  )

static

Compare two Aliases by their Addresses - Implements sort_t -.

Note

Non-visible Aliases are sorted to the end

Definition at line 68 of file sort.c.

{
  const struct AliasView *av_a = a;
  const struct AliasView *av_b = b;
 
  const struct AddressList *al_a = &av_a->alias->addr;
  const struct AddressList *al_b = &av_b->alias->addr;
 
  if (av_a->is_visible != av_b->is_visible)
    return av_a->is_visible ? -1 : 1;
 
  if (!av_a->is_visible)
    return 0;
 
  int r;
  if (al_a == al_b)
    r = 0;
  else if (!al_a)
    r = -1;
  else if (!al_b)
    r = 1;
  else
  {
    const struct Address *addr_a = TAILQ_FIRST(al_a);
    const struct Address *addr_b = TAILQ_FIRST(al_b);
    if (addr_a && addr_a->personal)
    {
      if (addr_b && addr_b->personal)
        r = mutt_str_coll(addr_a->personal, addr_b->personal);
      else
        r = 1;
    }
    else if (addr_b && addr_b->personal)
      r = -1;
    else if (addr_a && addr_b)
      r = mutt_str_coll(addr_a->mailbox, addr_b->mailbox);
    else
      r = 0;
  }
 
  return RSORT(r);
}

Here is the call graph for this function:

Here is the caller graph for this function:

alias_sort_unsort()

static int alias_sort_unsort ( const void *  a, const void *  b  )

static

Compare two Aliases by their original configuration position - Implements sort_t -.

Note

Non-visible Aliases are sorted to the end

Definition at line 116 of file sort.c.

{
  const struct AliasView *av_a = a;
  const struct AliasView *av_b = b;
 
  if (av_a->is_visible != av_b->is_visible)
    return av_a->is_visible ? -1 : 1;
 
  if (!av_a->is_visible)
    return 0;
 
  int r = (av_a->orig_seq - av_b->orig_seq);
 
  return RSORT(r);
}

Here is the caller graph for this function:

browser_compare_subject()

static int browser_compare_subject ( const void *  a, const void *  b  )

static

Compare the subject of two browser entries - Implements sort_t -.

Definition at line 40 of file sort.c.

{
  const struct FolderFile *pa = (const struct FolderFile *) a;
  const struct FolderFile *pb = (const struct FolderFile *) b;
 
  /* inbox should be sorted ahead of its siblings */
  int r = mutt_inbox_cmp(pa->name, pb->name);
  if (r == 0)
    r = mutt_str_coll(pa->name, pb->name);
  const short c_sort_browser = cs_subset_sort(NeoMutt->sub, "sort_browser");
  return (c_sort_browser & SORT_REVERSE) ? -r : r;
}

Here is the call graph for this function:

Here is the caller graph for this function:

browser_compare_order()

static int browser_compare_order ( const void *  a, const void *  b  )

static

Compare the order of creation of two browser entries - Implements sort_t -.

Note

This only affects browsing mailboxes and is a no-op for folders.

Definition at line 58 of file sort.c.

{
  const struct FolderFile *pa = (const struct FolderFile *) a;
  const struct FolderFile *pb = (const struct FolderFile *) b;
 
  const short c_sort_browser = cs_subset_sort(NeoMutt->sub, "sort_browser");
  return ((c_sort_browser & SORT_REVERSE) ? -1 : 1) * (pa->gen - pb->gen);
}

Here is the call graph for this function:

Here is the caller graph for this function:

browser_compare_desc()

static int browser_compare_desc ( const void *  a, const void *  b  )

static

Compare the descriptions of two browser entries - Implements sort_t -.

Definition at line 70 of file sort.c.

{
  const struct FolderFile *pa = (const struct FolderFile *) a;
  const struct FolderFile *pb = (const struct FolderFile *) b;
 
  int r = mutt_str_coll(pa->desc, pb->desc);
 
  const short c_sort_browser = cs_subset_sort(NeoMutt->sub, "sort_browser");
  return (c_sort_browser & SORT_REVERSE) ? -r : r;
}

Here is the call graph for this function:

Here is the caller graph for this function:

browser_compare_date()

static int browser_compare_date ( const void *  a, const void *  b  )

static

Compare the date of two browser entries - Implements sort_t -.

Definition at line 84 of file sort.c.

{
  const struct FolderFile *pa = (const struct FolderFile *) a;
  const struct FolderFile *pb = (const struct FolderFile *) b;
 
  int r = pa->mtime - pb->mtime;
 
  const short c_sort_browser = cs_subset_sort(NeoMutt->sub, "sort_browser");
  return (c_sort_browser & SORT_REVERSE) ? -r : r;
}

Here is the call graph for this function:

Here is the caller graph for this function:

browser_compare_size()

static int browser_compare_size ( const void *  a, const void *  b  )

static

Compare the size of two browser entries - Implements sort_t -.

Definition at line 98 of file sort.c.

{
  const struct FolderFile *pa = (const struct FolderFile *) a;
  const struct FolderFile *pb = (const struct FolderFile *) b;
 
  int r = pa->size - pb->size;
 
  const short c_sort_browser = cs_subset_sort(NeoMutt->sub, "sort_browser");
  return (c_sort_browser & SORT_REVERSE) ? -r : r;
}

Here is the call graph for this function:

Here is the caller graph for this function:

browser_compare_count()

static int browser_compare_count ( const void *  a, const void *  b  )

static

Compare the message count of two browser entries - Implements sort_t -.

Definition at line 112 of file sort.c.

{
  const struct FolderFile *pa = (const struct FolderFile *) a;
  const struct FolderFile *pb = (const struct FolderFile *) b;
 
  int r = 0;
  if (pa->has_mailbox && pb->has_mailbox)
    r = pa->msg_count - pb->msg_count;
  else if (pa->has_mailbox)
    r = -1;
  else
    r = 1;
 
  const short c_sort_browser = cs_subset_sort(NeoMutt->sub, "sort_browser");
  return (c_sort_browser & SORT_REVERSE) ? -r : r;
}

Here is the call graph for this function:

Here is the caller graph for this function:

browser_compare_count_new()

static int browser_compare_count_new ( const void *  a, const void *  b  )

static

Compare the new count of two browser entries - Implements sort_t -.

Definition at line 132 of file sort.c.

{
  const struct FolderFile *pa = (const struct FolderFile *) a;
  const struct FolderFile *pb = (const struct FolderFile *) b;
 
  int r = 0;
  if (pa->has_mailbox && pb->has_mailbox)
    r = pa->msg_unread - pb->msg_unread;
  else if (pa->has_mailbox)
    r = -1;
  else
    r = 1;
 
  const short c_sort_browser = cs_subset_sort(NeoMutt->sub, "sort_browser");
  return (c_sort_browser & SORT_REVERSE) ? -r : r;
}

Here is the call graph for this function:

Here is the caller graph for this function:

browser_compare()

static int browser_compare ( const void *  a, const void *  b  )

static

Sort the items in the browser - Implements sort_t -.

Wild compare function that calls the others. It's useful because it provides a way to tell "../" is always on the top of the list, independently of the sort method.

Definition at line 156 of file sort.c.

{
  const struct FolderFile *pa = (const struct FolderFile *) a;
  const struct FolderFile *pb = (const struct FolderFile *) b;
 
  if ((mutt_str_coll(pa->desc, "../") == 0) || (mutt_str_coll(pa->desc, "..") == 0))
    return -1;
  if ((mutt_str_coll(pb->desc, "../") == 0) || (mutt_str_coll(pb->desc, "..") == 0))
    return 1;
 
  const short c_sort_browser = cs_subset_sort(NeoMutt->sub, "sort_browser");
  switch (c_sort_browser & SORT_MASK)
  {
    case SORT_COUNT:
      return browser_compare_count(a, b);
    case SORT_DATE:
      return browser_compare_date(a, b);
    case SORT_DESC:
      return browser_compare_desc(a, b);
    case SORT_SIZE:
      return browser_compare_size(a, b);
    case SORT_UNREAD:
      return browser_compare_count_new(a, b);
    case SORT_SUBJECT:
      return browser_compare_subject(a, b);
    default:
    case SORT_ORDER:
      return browser_compare_order(a, b);
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

commands_cmp()

static int commands_cmp ( const void *  a, const void *  b  )

static

Compare two commands by name - Implements sort_t -.

Definition at line 40 of file command.c.

{
  struct Command x = *(const struct Command *) a;
  struct Command y = *(const struct Command *) b;
 
  return strcmp(x.name, y.name);
}

Here is the caller graph for this function:

compare_uid()

static int compare_uid ( const void *  a, const void *  b  )

static

Compare two Emails by UID - Implements sort_t -.

Definition at line 914 of file imap.c.

{
  const struct Email *ea = *(struct Email const *const *) a;
  const struct Email *eb = *(struct Email const *const *) b;
 
  const unsigned int ua = imap_edata_get((struct Email *) ea)->uid;
  const unsigned int ub = imap_edata_get((struct Email *) eb)->uid;
 
  return mutt_numeric_cmp(ua, ub);
}

Here is the call graph for this function:

Here is the caller graph for this function:

maildir_cmp_inode()

static int maildir_cmp_inode ( const void *  a, const void *  b  )

static

Compare two Maildirs by inode number - Implements sort_t -.

Definition at line 495 of file maildir.c.

{
  const struct MdEmail *ma = *(struct MdEmail **) a;
  const struct MdEmail *mb = *(struct MdEmail **) b;
 
  return ma->inode - mb->inode;
}

Here is the caller graph for this function:

mh_cmp_path()

static int mh_cmp_path ( const void *  a, const void *  b  )

static

Compare two Maildirs by path - Implements sort_t -.

Definition at line 558 of file mh.c.

{
  struct MdEmail const *const *pa = (struct MdEmail const *const *) a;
  struct MdEmail const *const *pb = (struct MdEmail const *const *) b;
  return strcmp((*pa)->email->path, (*pb)->email->path);
}

Here is the caller graph for this function:

sb_sort_count()

static int sb_sort_count ( const void *  a, const void *  b  )

static

Sort Sidebar entries by count - Implements sort_t -.

Definition at line 44 of file sort.c.

{
  const struct SbEntry *sbe1 = *(struct SbEntry const *const *) a;
  const struct SbEntry *sbe2 = *(struct SbEntry const *const *) b;
  const struct Mailbox *m1 = sbe1->mailbox;
  const struct Mailbox *m2 = sbe2->mailbox;
 
  int rc = 0;
  if (m1->msg_count == m2->msg_count)
    rc = mutt_str_coll(mailbox_path(m1), mailbox_path(m2));
  else
    rc = (m2->msg_count - m1->msg_count);
 
  if (sb_sort_reverse)
    rc = -rc;
  return rc;
}

Here is the call graph for this function:

Here is the caller graph for this function:

sb_sort_desc()

static int sb_sort_desc ( const void *  a, const void *  b  )

static

Sort Sidebar entries by description - Implements sort_t -.

Definition at line 65 of file sort.c.

{
  const struct SbEntry *sbe1 = *(struct SbEntry const *const *) a;
  const struct SbEntry *sbe2 = *(struct SbEntry const *const *) b;
  const struct Mailbox *m1 = sbe1->mailbox;
  const struct Mailbox *m2 = sbe2->mailbox;
 
  int rc = mutt_str_cmp(m1->name, m2->name);
 
  if (sb_sort_reverse)
    rc = -rc;
  return rc;
}

Here is the call graph for this function:

Here is the caller graph for this function:

sb_sort_flagged()

static int sb_sort_flagged ( const void *  a, const void *  b  )

static

Sort Sidebar entries by flagged - Implements sort_t -.

Definition at line 82 of file sort.c.

{
  const struct SbEntry *sbe1 = *(struct SbEntry const *const *) a;
  const struct SbEntry *sbe2 = *(struct SbEntry const *const *) b;
  const struct Mailbox *m1 = sbe1->mailbox;
  const struct Mailbox *m2 = sbe2->mailbox;
 
  int rc = 0;
  if (m1->msg_flagged == m2->msg_flagged)
    rc = mutt_str_coll(mailbox_path(m1), mailbox_path(m2));
  else
    rc = (m2->msg_flagged - m1->msg_flagged);
 
  if (sb_sort_reverse)
    rc = -rc;
  return rc;
}

Here is the call graph for this function:

Here is the caller graph for this function:

sb_sort_path()

static int sb_sort_path ( const void *  a, const void *  b  )

static

Sort Sidebar entries by path - Implements sort_t -.

Definition at line 103 of file sort.c.

{
  const struct SbEntry *sbe1 = *(struct SbEntry const *const *) a;
  const struct SbEntry *sbe2 = *(struct SbEntry const *const *) b;
  const struct Mailbox *m1 = sbe1->mailbox;
  const struct Mailbox *m2 = sbe2->mailbox;
 
  int rc = 0;
  rc = mutt_inbox_cmp(mailbox_path(m1), mailbox_path(m2));
  if (rc == 0)
    rc = mutt_str_coll(mailbox_path(m1), mailbox_path(m2));
 
  if (sb_sort_reverse)
    rc = -rc;
  return rc;
}

Here is the call graph for this function:

Here is the caller graph for this function:

sb_sort_unread()

static int sb_sort_unread ( const void *  a, const void *  b  )

static

Sort Sidebar entries by unread - Implements sort_t -.

Definition at line 123 of file sort.c.

{
  const struct SbEntry *sbe1 = *(struct SbEntry const *const *) a;
  const struct SbEntry *sbe2 = *(struct SbEntry const *const *) b;
  const struct Mailbox *m1 = sbe1->mailbox;
  const struct Mailbox *m2 = sbe2->mailbox;
 
  int rc = 0;
  if (m1->msg_unread == m2->msg_unread)
    rc = mutt_str_coll(mailbox_path(m1), mailbox_path(m2));
  else
    rc = (m2->msg_unread - m1->msg_unread);
 
  if (sb_sort_reverse)
    rc = -rc;
  return rc;
}

Here is the call graph for this function:

Here is the caller graph for this function:

sb_sort_order()

static int sb_sort_order ( const void *  a, const void *  b  )

static

Sort Sidebar entries by order of creation - Implements sort_t -.

Definition at line 144 of file sort.c.

{
  const struct SbEntry *sbe1 = *(struct SbEntry const *const *) a;
  const struct SbEntry *sbe2 = *(struct SbEntry const *const *) b;
  const struct Mailbox *m1 = sbe1->mailbox;
  const struct Mailbox *m2 = sbe2->mailbox;
 
  return (sb_sort_reverse ? -1 : 1) * (m1->gen - m2->gen);
}

Here is the caller graph for this function:

sb_sort_unsorted()

static int sb_sort_unsorted ( const void *  a, const void *  b  )

static

Sort Sidebar entries into their original order - Implements sort_t -.

Definition at line 157 of file sort.c.

{
  const struct SbEntry *sbe1 = *(struct SbEntry const *const *) a;
  const struct SbEntry *sbe2 = *(struct SbEntry const *const *) b;
 
  // This sort method isn't affected by the reverse flag
  return (sbe1->mailbox->gen - sbe2->mailbox->gen);
}

Here is the caller graph for this function: