dlg_index.c File Reference

Index Dialog. More...

#include "config.h"
#include <assert.h>
#include <stdbool.h>
#include <stdio.h>
#include "private.h"
#include "mutt/lib.h"
#include "config/lib.h"
#include "email/lib.h"
#include "core/lib.h"
#include "conn/lib.h"
#include "gui/lib.h"
#include "lib.h"
#include "color/lib.h"
#include "menu/lib.h"
#include "pager/lib.h"
#include "pattern/lib.h"
#include "format_flags.h"
#include "functions.h"
#include "globals.h"
#include "hdrline.h"
#include "hook.h"
#include "keymap.h"
#include "mutt_logging.h"
#include "mutt_mailbox.h"
#include "mutt_thread.h"
#include "mview.h"
#include "mx.h"
#include "opcodes.h"
#include "private_data.h"
#include "protos.h"
#include "shared_data.h"
#include "sort.h"
#include "status.h"
#include "notmuch/lib.h"
#include "nntp/lib.h"
#include "nntp/adata.h"
#include "monitor.h"
#include "sidebar/lib.h"

Include dependency graph for dlg_index.c:

Go to the source code of this file.

Functions
bool	check_acl (struct Mailbox *m, AclFlags acl, const char *msg)
	Check the ACLs for a function. More...
void	collapse_all (struct MailboxView *mv, struct Menu *menu, int toggle)
	Collapse/uncollapse all threads. More...
static void	uncollapse_thread (struct Mailbox *m, int index)
	Open a collapsed thread. More...
int	ci_next_undeleted (struct Mailbox *m, int msgno, bool uncollapse)
	Find the next undeleted email. More...
int	ci_previous_undeleted (struct Mailbox *m, int msgno, bool uncollapse)
	Find the previous undeleted email. More...
int	ci_first_message (struct Mailbox *m)
	Get index of first new message. More...
void	resort_index (struct MailboxView *mv, struct Menu *menu)
	Resort the index. More...
static void	update_index_threaded (struct MailboxView *mv, enum MxStatus check, int oldcount)
	Update the index (if threaded) More...
static void	update_index_unthreaded (struct MailboxView *mv, enum MxStatus check)
	Update the index (if unthreaded) More...
void	update_index (struct Menu *menu, struct MailboxView *mv, enum MxStatus check, int oldcount, const struct IndexSharedData *shared)
	Update the index. More...
void	mutt_update_index (struct Menu *menu, struct MailboxView *mv, enum MxStatus check, int oldcount, struct IndexSharedData *shared)
	Update the index. More...
static int	index_mailbox_observer (struct NotifyCallback *nc)
	Notification that a Mailbox has changed - Implements observer_t -. More...
void	change_folder_mailbox (struct Menu *menu, struct Mailbox *m, int *oldcount, struct IndexSharedData *shared, bool read_only)
	Change to a different Mailbox by pointer. More...
struct Mailbox *	change_folder_notmuch (struct Menu *menu, char *buf, int buflen, int *oldcount, struct IndexSharedData *shared, bool read_only)
	Change to a different Notmuch Mailbox by string. More...
void	change_folder_string (struct Menu *menu, char *buf, size_t buflen, int *oldcount, struct IndexSharedData *shared, bool read_only)
	Change to a different Mailbox by string. More...
void	index_make_entry (struct Menu *menu, char *buf, size_t buflen, int line)
	Format a menu item for the index list - Implements Menu::make_entry() -. More...
struct AttrColor *	index_color (struct Menu *menu, int line)
	Calculate the colour for a line of the index - Implements Menu::color() -. More...
void	mutt_draw_statusline (struct MuttWindow *win, int cols, const char *buf, size_t buflen)
	Draw a highlighted status bar. More...
struct Mailbox *	mutt_index_menu (struct MuttWindow *dlg, struct Mailbox *m_init)
	Display a list of emails. More...
void	mutt_set_header_color (struct Mailbox *m, struct Email *e)
	Select a colour for a message. More...
struct MuttWindow *	index_pager_init (void)
	Allocate the Windows for the Index/Pager. More...
void	dlg_change_folder (struct MuttWindow *dlg, struct Mailbox *m)
	Change the current folder, cautiously. More...

Variables
static const struct Mapping	IndexHelp []
	Help Bar for the Index dialog. More...
const struct Mapping	IndexNewsHelp []
	Help Bar for the News Index dialog. More...

Detailed Description

Index Dialog.

Authors

• Michael R. Elkins
• R Primus

Copyright

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 2 of the License, or (at your option) any later version.

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 dlg_index.c.

Function Documentation

check_acl()

bool check_acl	(	struct Mailbox *	m,
		AclFlags	acl,
		const char *	msg
	)

Check the ACLs for a function.

Parameters

m	Mailbox
acl	ACL, see AclFlags
msg	Error message for failure

Return values

true	The function is permitted

Definition at line 141 of file dlg_index.c.

{
  if (!m)
    return false;
 
  if (!(m->rights & acl))
  {
    /* L10N: %s is one of the CHECK_ACL entries below. */
    mutt_error(_("%s: Operation not permitted by ACL"), msg);
    return false;
  }
 
  return true;
}

Here is the caller graph for this function:

collapse_all()

void collapse_all	(	struct MailboxView *	mv,
		struct Menu *	menu,
		int	toggle
	)

Collapse/uncollapse all threads.

Parameters

mv	Mailbox View
menu	current menu
toggle	toggle collapsed state

This function is called by the OP_MAIN_COLLAPSE_ALL command and on folder enter if the $collapse_all option is set. In the first case, the toggle parameter is 1 to actually toggle collapsed/uncollapsed state on all threads. In the second case, the toggle parameter is 0, actually turning this function into a one-way collapse.

Definition at line 168 of file dlg_index.c.

{
  if (!mv || !mv->mailbox || (mv->mailbox->msg_count == 0) || !menu)
    return;
 
  struct Email *e_cur = mutt_get_virt_email(mv->mailbox, menu_get_index(menu));
  if (!e_cur)
    return;
 
  int final;
 
  /* Figure out what the current message would be after folding / unfolding,
   * so that we can restore the cursor in a sane way afterwards. */
  if (e_cur->collapsed && toggle)
    final = mutt_uncollapse_thread(e_cur);
  else if (mutt_thread_can_collapse(e_cur))
    final = mutt_collapse_thread(e_cur);
  else
    final = e_cur->vnum;
 
  if (final == -1)
    return;
 
  struct Email *base = mutt_get_virt_email(mv->mailbox, final);
  if (!base)
    return;
 
  /* Iterate all threads, perform collapse/uncollapse as needed */
  mv->collapsed = toggle ? !mv->collapsed : true;
  mutt_thread_collapse(mv->threads, mv->collapsed);
 
  /* Restore the cursor */
  mutt_set_vnum(mv->mailbox);
  menu->max = mv->mailbox->vcount;
  for (int i = 0; i < mv->mailbox->vcount; i++)
  {
    struct Email *e = mutt_get_virt_email(mv->mailbox, i);
    if (!e)
      break;
    if (e->index == base->index)
    {
      menu_set_index(menu, i);
      break;
    }
  }
 
  menu_queue_redraw(menu, MENU_REDRAW_INDEX);
}

Here is the call graph for this function:

Here is the caller graph for this function:

uncollapse_thread()

static void uncollapse_thread ( struct Mailbox *  m, int  index  )

static

Open a collapsed thread.

Parameters

m	Mailbox
index	Message number

Definition at line 222 of file dlg_index.c.

{
  struct Email *e = mutt_get_virt_email(m, index);
  if (e && e->collapsed)
  {
    mutt_uncollapse_thread(e);
    mutt_set_vnum(m);
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

ci_next_undeleted()

int ci_next_undeleted	(	struct Mailbox *	m,
		int	msgno,
		bool	uncollapse
	)

Find the next undeleted email.

Parameters

m	Mailbox
msgno	Message number to start at
uncollapse	Open collapsed threads

Return values

>=0	Message number of next undeleted email
-1	No more undeleted messages

Definition at line 240 of file dlg_index.c.

{
  if (!m)
    return -1;
 
  int index = -1;
 
  for (int i = msgno + 1; i < m->vcount; i++)
  {
    struct Email *e = mutt_get_virt_email(m, i);
    if (!e)
      continue;
    if (!e->deleted)
    {
      index = i;
      break;
    }
  }
 
  if (uncollapse)
    uncollapse_thread(m, index);
 
  return index;
}

Here is the call graph for this function:

Here is the caller graph for this function:

ci_previous_undeleted()

int ci_previous_undeleted	(	struct Mailbox *	m,
		int	msgno,
		bool	uncollapse
	)

Find the previous undeleted email.

Parameters

m	Mailbox
msgno	Message number to start at
uncollapse	Open collapsed threads

Return values

>=0	Message number of next undeleted email
-1	No more undeleted messages

Definition at line 273 of file dlg_index.c.

{
  if (!m)
    return -1;
 
  int index = -1;
 
  for (int i = msgno - 1; i >= 0; i--)
  {
    struct Email *e = mutt_get_virt_email(m, i);
    if (!e)
      continue;
    if (!e->deleted)
    {
      index = i;
      break;
    }
  }
 
  if (uncollapse)
    uncollapse_thread(m, index);
 
  return index;
}

Here is the call graph for this function:

Here is the caller graph for this function:

ci_first_message()

int ci_first_message

(

struct Mailbox *

m

)

Get index of first new message.

Parameters

m

Mailbox

Return values

num	Index of first new message

Return the index of the first new message, or failing that, the first unread message.

Definition at line 306 of file dlg_index.c.

{
  if (!m || (m->msg_count == 0))
    return 0;
 
  int old = -1;
  for (int i = 0; i < m->vcount; i++)
  {
    struct Email *e = mutt_get_virt_email(m, i);
    if (!e)
      continue;
    if (!e->read && !e->deleted)
    {
      if (!e->old)
        return i;
      if (old == -1)
        old = i;
    }
  }
  if (old != -1)
    return old;
 
  /* If `$use_threads` is not threaded and `$sort` is reverse, the latest
   * message is first.  Otherwise, the latest message is first if exactly
   * one of `$use_threads` and `$sort` are reverse.
   */
  short c_sort = cs_subset_sort(m->sub, "sort");
  if ((c_sort & SORT_MASK) == SORT_THREADS)
    c_sort = cs_subset_sort(m->sub, "sort_aux");
  bool reverse = false;
  switch (mutt_thread_style())
  {
    case UT_FLAT:
      reverse = c_sort & SORT_REVERSE;
      break;
    case UT_THREADS:
      reverse = c_sort & SORT_REVERSE;
      break;
    case UT_REVERSE:
      reverse = !(c_sort & SORT_REVERSE);
      break;
    default:
      assert(false);
  }
 
  if (reverse || (m->vcount == 0))
    return 0;
 
  return m->vcount - 1;
}

Here is the call graph for this function:

Here is the caller graph for this function:

resort_index()

void resort_index	(	struct MailboxView *	mv,
		struct Menu *	menu
	)

Resort the index.

Parameters

mv	Mailbox View
menu	Current Menu

Definition at line 362 of file dlg_index.c.

{
  if (!mv || !mv->mailbox || !menu)
    return;
 
  struct Mailbox *m = mv->mailbox;
  const int old_index = menu_get_index(menu);
  struct Email *e_cur = mutt_get_virt_email(m, old_index);
 
  int new_index = -1;
  mutt_sort_headers(m, mv->threads, false, &mv->vsize);
 
  /* Restore the current message */
  for (int i = 0; i < m->vcount; i++)
  {
    struct Email *e = mutt_get_virt_email(m, i);
    if (!e)
      continue;
    if (e == e_cur)
    {
      new_index = i;
      break;
    }
  }
 
  if (mutt_using_threads() && (old_index < 0))
    new_index = mutt_parent_message(e_cur, false);
 
  if (old_index < 0)
    new_index = ci_first_message(m);
 
  menu->max = m->vcount;
  menu_set_index(menu, new_index);
  menu_queue_redraw(menu, MENU_REDRAW_INDEX);
}

Here is the call graph for this function:

Here is the caller graph for this function:

update_index_threaded()

static void update_index_threaded ( struct MailboxView *  mv, enum MxStatus  check, int  oldcount  )

static

Update the index (if threaded)

Parameters

mv	Mailbox
check	Flags, e.g. MX_STATUS_REOPENED
oldcount	How many items are currently in the index

Definition at line 404 of file dlg_index.c.

{
  struct Email **save_new = NULL;
  const bool lmt = mview_has_limit(mv);
 
  struct Mailbox *m = mv->mailbox;
  int num_new = MAX(0, m->msg_count - oldcount);
 
  const bool c_uncollapse_new = cs_subset_bool(m->sub, "uncollapse_new");
  /* save the list of new messages */
  if ((check != MX_STATUS_REOPENED) && (oldcount > 0) &&
      (lmt || c_uncollapse_new) && (num_new > 0))
  {
    save_new = mutt_mem_malloc(num_new * sizeof(struct Email *));
    for (int i = oldcount; i < m->msg_count; i++)
      save_new[i - oldcount] = m->emails[i];
  }
 
  /* Sort first to thread the new messages, because some patterns
   * require the threading information.
   *
   * If the mailbox was reopened, need to rethread from scratch. */
  mutt_sort_headers(m, mv->threads, (check == MX_STATUS_REOPENED), &mv->vsize);
 
  if (lmt)
  {
    for (int i = 0; i < m->msg_count; i++)
    {
      struct Email *e = m->emails[i];
 
      if ((e->limit_visited && e->visible) ||
          mutt_pattern_exec(SLIST_FIRST(mv->limit_pattern),
                            MUTT_MATCH_FULL_ADDRESS, m, e, NULL))
      {
        /* vnum will get properly set by mutt_set_vnum(), which
         * is called by mutt_sort_headers() just below. */
        e->vnum = 1;
        e->visible = true;
      }
      else
      {
        e->vnum = -1;
        e->visible = false;
      }
 
      // mark email as visited so we don't re-apply the pattern next time
      e->limit_visited = true;
    }
    /* Need a second sort to set virtual numbers and redraw the tree */
    mutt_sort_headers(m, mv->threads, false, &mv->vsize);
  }
 
  /* uncollapse threads with new mail */
  if (c_uncollapse_new)
  {
    if (check == MX_STATUS_REOPENED)
    {
      mv->collapsed = false;
      mutt_thread_collapse(mv->threads, mv->collapsed);
      mutt_set_vnum(m);
    }
    else if (oldcount > 0)
    {
      for (int j = 0; j < num_new; j++)
      {
        if (save_new[j]->visible)
        {
          mutt_uncollapse_thread(save_new[j]);
        }
      }
      mutt_set_vnum(m);
    }
  }
 
  FREE(&save_new);
}

Here is the call graph for this function:

Here is the caller graph for this function:

update_index_unthreaded()

static void update_index_unthreaded ( struct MailboxView *  mv, enum MxStatus  check  )

static

Update the index (if unthreaded)

Parameters

mv	Mailbox
check	Flags, e.g. MX_STATUS_REOPENED

Definition at line 486 of file dlg_index.c.

{
  /* We are in a limited view. Check if the new message(s) satisfy
   * the limit criteria. If they do, set their virtual msgno so that
   * they will be visible in the limited view */
  if (mview_has_limit(mv))
  {
    int padding = mx_msg_padding_size(mv->mailbox);
    mv->mailbox->vcount = mv->vsize = 0;
    for (int i = 0; i < mv->mailbox->msg_count; i++)
    {
      struct Email *e = mv->mailbox->emails[i];
      if (!e)
        break;
 
      if ((e->limit_visited && e->visible) ||
          mutt_pattern_exec(SLIST_FIRST(mv->limit_pattern),
                            MUTT_MATCH_FULL_ADDRESS, mv->mailbox, e, NULL))
      {
        assert(mv->mailbox->vcount < mv->mailbox->msg_count);
        e->vnum = mv->mailbox->vcount;
        mv->mailbox->v2r[mv->mailbox->vcount] = i;
        e->visible = true;
        mv->mailbox->vcount++;
        struct Body *b = e->body;
        mv->vsize += b->length + b->offset - b->hdr_offset + padding;
      }
      else
      {
        e->visible = false;
      }
 
      // mark email as visited so we don't re-apply the pattern next time
      e->limit_visited = true;
    }
  }
 
  /* if the mailbox was reopened, need to rethread from scratch */
  mutt_sort_headers(mv->mailbox, mv->threads, (check == MX_STATUS_REOPENED), &mv->vsize);
}

Here is the call graph for this function:

Here is the caller graph for this function:

update_index()

void update_index	(	struct Menu *	menu,
		struct MailboxView *	mv,
		enum MxStatus	check,
		int	oldcount,
		const struct IndexSharedData *	shared
	)

Update the index.

Parameters

menu	Current Menu
mv	Mailbox
check	Flags, e.g. MX_STATUS_REOPENED
oldcount	How many items are currently in the index
shared	Shared Index data

Definition at line 535 of file dlg_index.c.

{
  if (!menu || !mv)
    return;
 
  struct Mailbox *m = mv->mailbox;
  if (mutt_using_threads())
    update_index_threaded(mv, check, oldcount);
  else
    update_index_unthreaded(mv, check);
 
  const int old_index = menu_get_index(menu);
  int index = -1;
  if (oldcount)
  {
    /* restore the current message to the message it was pointing to */
    for (int i = 0; i < m->vcount; i++)
    {
      struct Email *e = mutt_get_virt_email(m, i);
      if (!e)
        continue;
      if (index_shared_data_is_cur_email(shared, e))
      {
        index = i;
        break;
      }
    }
  }
 
  if (index < 0)
  {
    index = (old_index < m->vcount) ? old_index : ci_first_message(m);
  }
  menu_set_index(menu, index);
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_update_index()

void mutt_update_index	(	struct Menu *	menu,
		struct MailboxView *	mv,
		enum MxStatus	check,
		int	oldcount,
		struct IndexSharedData *	shared
	)

Update the index.

Parameters

menu	Current Menu
mv	Mailbox
check	Flags, e.g. MX_STATUS_REOPENED
oldcount	How many items are currently in the index
shared	Shared Index data

Definition at line 580 of file dlg_index.c.

{
  update_index(menu, mv, check, oldcount, shared);
}

Here is the call graph for this function:

change_folder_mailbox()

void change_folder_mailbox	(	struct Menu *	menu,
		struct Mailbox *	m,
		int *	oldcount,
		struct IndexSharedData *	shared,
		bool	read_only
	)

Change to a different Mailbox by pointer.

Parameters

menu	Current Menu
m	Mailbox
oldcount	How many items are currently in the index
shared	Shared Index data
read_only	Open Mailbox in read-only mode

Definition at line 617 of file dlg_index.c.

{
  if (!m)
    return;
 
  /* keepalive failure in mutt_enter_fname may kill connection. */
  if (shared->mailbox && (mutt_buffer_is_empty(&shared->mailbox->pathbuf)))
  {
    mview_free(&shared->mailboxview);
    mailbox_free(&shared->mailbox);
  }
 
  if (shared->mailbox)
  {
    char *new_last_folder = NULL;
#ifdef USE_INOTIFY
    int monitor_remove_rc = mutt_monitor_remove(NULL);
#endif
#ifdef USE_COMP_MBOX
    if (shared->mailbox->compress_info && (shared->mailbox->realpath[0] != '\0'))
      new_last_folder = mutt_str_dup(shared->mailbox->realpath);
    else
#endif
      new_last_folder = mutt_str_dup(mailbox_path(shared->mailbox));
    *oldcount = shared->mailbox->msg_count;
 
    const enum MxStatus check = mx_mbox_close(shared->mailbox);
    if (check == MX_STATUS_OK)
    {
      mview_free(&shared->mailboxview);
      if (shared->mailbox != m)
      {
        mailbox_free(&shared->mailbox);
      }
    }
    else
    {
#ifdef USE_INOTIFY
      if (monitor_remove_rc == 0)
        mutt_monitor_add(NULL);
#endif
      if ((check == MX_STATUS_NEW_MAIL) || (check == MX_STATUS_REOPENED))
        update_index(menu, shared->mailboxview, check, *oldcount, shared);
 
      FREE(&new_last_folder);
      OptSearchInvalid = true;
      menu_queue_redraw(menu, MENU_REDRAW_INDEX);
      return;
    }
    FREE(&LastFolder);
    LastFolder = new_last_folder;
  }
  mutt_str_replace(&CurrentFolder, mailbox_path(m));
 
  /* If the `folder-hook` were to call `unmailboxes`, then the Mailbox (`m`)
   * could be deleted, leaving `m` dangling. */
  // TODO: Refactor this function to avoid the need for an observer
  notify_observer_add(m->notify, NT_MAILBOX, index_mailbox_observer, &m);
  char *dup_path = mutt_str_dup(mailbox_path(m));
  char *dup_name = mutt_str_dup(m->name);
 
  mutt_folder_hook(dup_path, dup_name);
  if (m)
  {
    /* `m` is still valid, but we won't need the observer again before the end
     * of the function. */
    notify_observer_remove(m->notify, index_mailbox_observer, &m);
  }
  else
  {
    // Recreate the Mailbox as the folder-hook might have invoked `mailboxes`
    // and/or `unmailboxes`.
    m = mx_path_resolve(dup_path);
  }
 
  FREE(&dup_path);
  FREE(&dup_name);
 
  if (!m)
    return;
 
  const OpenMailboxFlags flags = read_only ? MUTT_READONLY : MUTT_OPEN_NO_FLAGS;
  if (mx_mbox_open(m, flags))
  {
    struct MailboxView *mv = mview_new(m);
    index_shared_data_set_context(shared, mv);
 
    menu->max = m->msg_count;
    menu_set_index(menu, ci_first_message(shared->mailbox));
#ifdef USE_INOTIFY
    mutt_monitor_add(NULL);
#endif
  }
  else
  {
    index_shared_data_set_context(shared, NULL);
    menu_set_index(menu, 0);
  }
 
  const bool c_collapse_all = cs_subset_bool(shared->sub, "collapse_all");
  if (mutt_using_threads() && c_collapse_all)
    collapse_all(shared->mailboxview, menu, 0);
 
  mutt_clear_error();
  /* force the mailbox check after we have changed the folder */
  struct EventMailbox ev_m = { shared->mailbox };
  mutt_mailbox_check(ev_m.mailbox, MUTT_MAILBOX_CHECK_FORCE);
  menu_queue_redraw(menu, MENU_REDRAW_FULL);
  OptSearchInvalid = true;
}

Here is the call graph for this function:

Here is the caller graph for this function:

change_folder_notmuch()

struct Mailbox * change_folder_notmuch	(	struct Menu *	menu,
		char *	buf,
		int	buflen,
		int *	oldcount,
		struct IndexSharedData *	shared,
		bool	read_only
	)

Change to a different Notmuch Mailbox by string.

Parameters

menu	Current Menu
buf	Folder to change to
buflen	Length of buffer
oldcount	How many items are currently in the index
shared	Shared Index data
read_only	Open Mailbox in read-only mode

Return values

ptr

Mailbox

Definition at line 740 of file dlg_index.c.

{
  if (!nm_url_from_query(NULL, buf, buflen))
  {
    mutt_message(_("Failed to create query, aborting"));
    return NULL;
  }
 
  struct Mailbox *m_query = mx_path_resolve(buf);
  change_folder_mailbox(menu, m_query, oldcount, shared, read_only);
  return m_query;
}

Here is the call graph for this function:

Here is the caller graph for this function:

change_folder_string()

void change_folder_string	(	struct Menu *	menu,
		char *	buf,
		size_t	buflen,
		int *	oldcount,
		struct IndexSharedData *	shared,
		bool	read_only
	)

Change to a different Mailbox by string.

Parameters

menu	Current Menu
buf	Folder to change to
buflen	Length of buffer
oldcount	How many items are currently in the index
shared	Shared Index data
read_only	Open Mailbox in read-only mode

Definition at line 764 of file dlg_index.c.

{
#ifdef USE_NNTP
  if (OptNews)
  {
    OptNews = false;
    nntp_expand_path(buf, buflen, &CurrentNewsSrv->conn->account);
  }
  else
#endif
  {
    const char *const c_folder = cs_subset_string(shared->sub, "folder");
    mx_path_canon(buf, buflen, c_folder, NULL);
  }
 
  enum MailboxType type = mx_path_probe(buf);
  if ((type == MUTT_MAILBOX_ERROR) || (type == MUTT_UNKNOWN))
  {
    // Look for a Mailbox by its description, before failing
    struct Mailbox *m = mailbox_find_name(buf);
    if (m)
    {
      change_folder_mailbox(menu, m, oldcount, shared, read_only);
    }
    else
    {
      mutt_error(_("%s is not a mailbox"), buf);
    }
    return;
  }
 
  struct Mailbox *m = mx_path_resolve(buf);
  change_folder_mailbox(menu, m, oldcount, shared, read_only);
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_draw_statusline()

void mutt_draw_statusline	(	struct MuttWindow *	win,
		int	cols,
		const char *	buf,
		size_t	buflen
	)

Draw a highlighted status bar.

Parameters

win	Window
cols	Maximum number of screen columns
buf	Message to be displayed
buflen	Length of the buffer

Users configure the highlighting of the status bar, e.g. color status red default "[0-9][0-9]:[0-9][0-9]"

Where regexes overlap, the one nearest the start will be used. If two regexes start at the same place, the longer match will be used.

Colours of the status bar

< First character of that colour

< Last character of that colour

Definition at line 928 of file dlg_index.c.

{
  if (!buf || !stdscr)
    return;
 
  size_t i = 0;
  size_t offset = 0;
  bool found = false;
  size_t chunks = 0;
  size_t len = 0;
 
  struct StatusSyntax
  {
    struct AttrColor *attr_color;
    int first; 
    int last;  
  } *syntax = NULL;
 
  struct AttrColor *ac_base = merged_color_overlay(simple_color_get(MT_COLOR_NORMAL),
                                                   simple_color_get(MT_COLOR_STATUS));
  do
  {
    struct RegexColor *cl = NULL;
    found = false;
 
    if (!buf[offset])
      break;
 
    /* loop through each "color status regex" */
    STAILQ_FOREACH(cl, regex_colors_get_list(MT_COLOR_STATUS), entries)
    {
      regmatch_t pmatch[cl->match + 1];
 
      if (regexec(&cl->regex, buf + offset, cl->match + 1, pmatch, 0) != 0)
        continue; /* regex doesn't match the status bar */
 
      int first = pmatch[cl->match].rm_so + offset;
      int last = pmatch[cl->match].rm_eo + offset;
 
      if (first == last)
        continue; /* ignore an empty regex */
 
      if (!found)
      {
        chunks++;
        mutt_mem_realloc(&syntax, chunks * sizeof(struct StatusSyntax));
      }
 
      i = chunks - 1;
      if (!found || (first < syntax[i].first) ||
          ((first == syntax[i].first) && (last > syntax[i].last)))
      {
        struct AttrColor *ac_merge = merged_color_overlay(ac_base, &cl->attr_color);
 
        syntax[i].attr_color = ac_merge;
        syntax[i].first = first;
        syntax[i].last = last;
      }
      found = true;
    }
 
    if (syntax)
    {
      offset = syntax[i].last;
    }
  } while (found);
 
  /* Only 'len' bytes will fit into 'cols' screen columns */
  len = mutt_wstr_trunc(buf, buflen, cols, NULL);
 
  offset = 0;
 
  if ((chunks > 0) && (syntax[0].first > 0))
  {
    /* Text before the first highlight */
    mutt_window_addnstr(win, buf, MIN(len, syntax[0].first));
    mutt_curses_set_color(ac_base);
    if (len <= syntax[0].first)
      goto dsl_finish; /* no more room */
 
    offset = syntax[0].first;
  }
 
  for (i = 0; i < chunks; i++)
  {
    /* Highlighted text */
    mutt_curses_set_color(syntax[i].attr_color);
    mutt_window_addnstr(win, buf + offset, MIN(len, syntax[i].last) - offset);
    if (len <= syntax[i].last)
      goto dsl_finish; /* no more room */
 
    size_t next;
    if ((i + 1) == chunks)
    {
      next = len;
    }
    else
    {
      next = MIN(len, syntax[i + 1].first);
    }
 
    mutt_curses_set_color(ac_base);
    offset = syntax[i].last;
    mutt_window_addnstr(win, buf + offset, next - offset);
 
    offset = next;
    if (offset >= len)
      goto dsl_finish; /* no more room */
  }
 
  mutt_curses_set_color(ac_base);
  if (offset < len)
  {
    /* Text after the last highlight */
    mutt_window_addnstr(win, buf + offset, len - offset);
  }
 
  int width = mutt_strwidth(buf);
  if (width < cols)
  {
    /* Pad the rest of the line with whitespace */
    mutt_paddstr(win, cols - width, "");
  }
dsl_finish:
  FREE(&syntax);
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_index_menu()

struct Mailbox * mutt_index_menu	(	struct MuttWindow *	dlg,
		struct Mailbox *	m_init
	)

Display a list of emails.

Parameters

dlg	Dialog containing Windows to draw on
m_init	Initial mailbox

Return values

Mailbox

open in the index

Definition at line 1064 of file dlg_index.c.

{
  /* Make sure use_threads/sort/sort_aux are coherent */
  index_adjust_sort_threads(NeoMutt->sub);
 
  struct IndexSharedData *shared = dlg->wdata;
  index_shared_data_set_context(shared, mview_new(m_init));
 
  struct MuttWindow *panel_index = window_find_child(dlg, WT_INDEX);
 
  struct IndexPrivateData *priv = panel_index->wdata;
  priv->attach_msg = OptAttachMsg;
  priv->win_index = window_find_child(panel_index, WT_MENU);
 
  int op = OP_NULL;
 
#ifdef USE_NNTP
  if (shared->mailbox && (shared->mailbox->type == MUTT_NNTP))
    dlg->help_data = IndexNewsHelp;
  else
#endif
    dlg->help_data = IndexHelp;
  dlg->help_menu = MENU_INDEX;
 
  priv->menu = priv->win_index->wdata;
  priv->menu->make_entry = index_make_entry;
  priv->menu->color = index_color;
  priv->menu->max = shared->mailbox ? shared->mailbox->vcount : 0;
  menu_set_index(priv->menu, ci_first_message(shared->mailbox));
  mutt_window_reflow(NULL);
 
  if (!priv->attach_msg)
  {
    /* force the mailbox check after we enter the folder */
    mutt_mailbox_check(shared->mailbox, MUTT_MAILBOX_CHECK_FORCE);
  }
#ifdef USE_INOTIFY
  mutt_monitor_add(NULL);
#endif
 
  {
    const bool c_collapse_all = cs_subset_bool(shared->sub, "collapse_all");
    if (mutt_using_threads() && c_collapse_all)
    {
      collapse_all(shared->mailboxview, priv->menu, 0);
      menu_queue_redraw(priv->menu, MENU_REDRAW_FULL);
    }
  }
 
  int rc = 0;
  do
  {
    /* Clear the tag prefix unless we just started it.
     * Don't clear the prefix on a timeout, but do clear on an abort */
    if (priv->tag && (op != OP_TAG_PREFIX) && (op != OP_TAG_PREFIX_COND) && (op != OP_TIMEOUT))
    {
      priv->tag = false;
    }
 
    /* check if we need to resort the index because just about
     * any 'op' below could do mutt_enter_command(), either here or
     * from any new priv->menu launched, and change $sort/$sort_aux */
    if (OptNeedResort && shared->mailbox && (shared->mailbox->msg_count != 0) &&
        (menu_get_index(priv->menu) >= 0))
    {
      resort_index(shared->mailboxview, priv->menu);
    }
 
    priv->menu->max = shared->mailbox ? shared->mailbox->vcount : 0;
    priv->oldcount = shared->mailbox ? shared->mailbox->msg_count : 0;
 
    {
      if (shared->mailboxview && OptRedrawTree && shared->mailbox &&
          (shared->mailbox->msg_count != 0) && mutt_using_threads())
      {
        mutt_draw_tree(shared->mailboxview->threads);
        OptRedrawTree = false;
      }
    }
 
    if (shared->mailbox && shared->mailboxview)
    {
      mailbox_gc_run();
 
      shared->mailboxview->menu = priv->menu;
      /* check for new mail in the mailbox.  If nonzero, then something has
       * changed about the file (either we got new mail or the file was
       * modified underneath us.) */
      enum MxStatus check = mx_mbox_check(shared->mailbox);
 
      if (check == MX_STATUS_ERROR)
      {
        if (mutt_buffer_is_empty(&shared->mailbox->pathbuf))
        {
          /* fatal error occurred */
          mview_free(&shared->mailboxview);
          menu_queue_redraw(priv->menu, MENU_REDRAW_FULL);
        }
 
        OptSearchInvalid = true;
      }
      else if ((check == MX_STATUS_NEW_MAIL) || (check == MX_STATUS_REOPENED) ||
               (check == MX_STATUS_FLAGS))
      {
        /* notify the user of new mail */
        if (check == MX_STATUS_REOPENED)
        {
          mutt_error(_("Mailbox was externally modified.  Flags may be wrong."));
        }
        else if (check == MX_STATUS_NEW_MAIL)
        {
          for (size_t i = 0; i < shared->mailbox->msg_count; i++)
          {
            const struct Email *e = shared->mailbox->emails[i];
            if (e && !e->read && !e->old)
            {
              mutt_message(_("New mail in this mailbox"));
              const bool c_beep_new = cs_subset_bool(shared->sub, "beep_new");
              if (c_beep_new)
                mutt_beep(true);
              const char *const c_new_mail_command = cs_subset_string(shared->sub, "new_mail_command");
              if (c_new_mail_command)
              {
                char cmd[1024] = { 0 };
                menu_status_line(cmd, sizeof(cmd), shared, NULL, sizeof(cmd),
                                 NONULL(c_new_mail_command));
                if (mutt_system(cmd) != 0)
                  mutt_error(_("Error running \"%s\""), cmd);
              }
              break;
            }
          }
        }
        else if (check == MX_STATUS_FLAGS)
        {
          mutt_message(_("Mailbox was externally modified"));
        }
 
        /* avoid the message being overwritten by mailbox */
        priv->do_mailbox_notify = false;
 
        bool verbose = shared->mailbox->verbose;
        shared->mailbox->verbose = false;
        update_index(priv->menu, shared->mailboxview, check, priv->oldcount, shared);
        shared->mailbox->verbose = verbose;
        priv->menu->max = shared->mailbox->vcount;
        menu_queue_redraw(priv->menu, MENU_REDRAW_FULL);
        OptSearchInvalid = true;
      }
 
      index_shared_data_set_email(shared, mutt_get_virt_email(shared->mailbox,
                                                              menu_get_index(priv->menu)));
    }
 
    if (!priv->attach_msg)
    {
      /* check for new mail in the incoming folders */
      priv->oldcount = priv->newcount;
      priv->newcount = mutt_mailbox_check(shared->mailbox, MUTT_MAILBOX_CHECK_NO_FLAGS);
      if (priv->do_mailbox_notify)
      {
        if (mutt_mailbox_notify(shared->mailbox))
        {
          const bool c_beep_new = cs_subset_bool(shared->sub, "beep_new");
          if (c_beep_new)
            mutt_beep(true);
          const char *const c_new_mail_command = cs_subset_string(shared->sub, "new_mail_command");
          if (c_new_mail_command)
          {
            char cmd[1024] = { 0 };
            menu_status_line(cmd, sizeof(cmd), shared, priv->menu, sizeof(cmd),
                             NONULL(c_new_mail_command));
            if (mutt_system(cmd) != 0)
              mutt_error(_("Error running \"%s\""), cmd);
          }
        }
      }
      else
      {
        priv->do_mailbox_notify = true;
      }
    }
 
    window_redraw(NULL);
 
    /* give visual indication that the next command is a tag- command */
    if (priv->tag)
      msgwin_set_text(MT_COLOR_NORMAL, "tag-");
 
    const bool c_arrow_cursor = cs_subset_bool(shared->sub, "arrow_cursor");
    const bool c_braille_friendly = cs_subset_bool(shared->sub, "braille_friendly");
    const int index = menu_get_index(priv->menu);
    if (c_arrow_cursor)
    {
      mutt_window_move(priv->menu->win, 2, index - priv->menu->top);
    }
    else if (c_braille_friendly)
    {
      mutt_window_move(priv->menu->win, 0, index - priv->menu->top);
    }
    else
    {
      mutt_window_move(priv->menu->win, priv->menu->win->state.cols - 1,
                       index - priv->menu->top);
    }
    mutt_refresh();
 
    if (SigWinch)
    {
      SigWinch = false;
      window_invalidate_all();
      mutt_resize_screen();
      priv->menu->top = 0; /* so we scroll the right amount */
      /* force a real complete redraw.  clrtobot() doesn't seem to be able
       * to handle every case without this.  */
      clearok(stdscr, true);
      msgwin_clear_text();
      continue;
    }
 
    window_redraw(NULL);
    op = km_dokey(MENU_INDEX);
 
    /* either user abort or timeout */
    if (op < OP_NULL)
    {
      mutt_timeout_hook();
      if (priv->tag)
        msgwin_clear_text();
      continue;
    }
 
    mutt_debug(LL_DEBUG1, "Got op %s (%d)\n", opcodes_get_name(op), op);
 
    /* special handling for the priv->tag-prefix function */
    const bool c_auto_tag = cs_subset_bool(shared->sub, "auto_tag");
    if ((op == OP_TAG_PREFIX) || (op == OP_TAG_PREFIX_COND))
    {
      /* A second priv->tag-prefix command aborts */
      if (priv->tag)
      {
        priv->tag = false;
        msgwin_clear_text();
        continue;
      }
 
      if (!shared->mailbox)
      {
        mutt_error(_("No mailbox is open"));
        continue;
      }
 
      if (shared->mailbox->msg_tagged == 0)
      {
        if (op == OP_TAG_PREFIX)
        {
          mutt_error(_("No tagged messages"));
        }
        else if (op == OP_TAG_PREFIX_COND)
        {
          mutt_flush_macro_to_endcond();
          mutt_message(_("Nothing to do"));
        }
        continue;
      }
 
      /* get the real command */
      priv->tag = true;
      continue;
    }
    else if (c_auto_tag && shared->mailbox && (shared->mailbox->msg_tagged != 0))
    {
      priv->tag = true;
    }
 
    mutt_clear_error();
 
#ifdef USE_NNTP
    OptNews = false; /* for any case */
#endif
 
#ifdef USE_NOTMUCH
    nm_db_debug_check(shared->mailbox);
#endif
 
    rc = index_function_dispatcher(priv->win_index, op);
 
    if (rc == FR_UNKNOWN)
      rc = menu_function_dispatcher(priv->win_index, op);
 
#ifdef USE_SIDEBAR
    if (rc == FR_UNKNOWN)
    {
      struct MuttWindow *win_sidebar = window_find_child(dlg, WT_SIDEBAR);
      rc = sb_function_dispatcher(win_sidebar, op);
    }
#endif
    if (rc == FR_UNKNOWN)
      rc = global_function_dispatcher(NULL, op);
 
    if (rc == FR_UNKNOWN)
      km_error_key(MENU_INDEX);
 
#ifdef USE_NOTMUCH
    nm_db_debug_check(shared->mailbox);
#endif
  } while (rc != FR_DONE);
 
  mview_free(&shared->mailboxview);
 
  return shared->mailbox;
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_set_header_color()

void mutt_set_header_color	(	struct Mailbox *	m,
		struct Email *	e
	)

Select a colour for a message.

Parameters

m	Mailbox
e	Current Email

Definition at line 1382 of file dlg_index.c.

{
  if (!e)
    return;
 
  struct RegexColor *color = NULL;
  struct PatternCache cache = { 0 };
 
  struct AttrColor *ac_merge = NULL;
  STAILQ_FOREACH(color, regex_colors_get_list(MT_COLOR_INDEX), entries)
  {
    if (mutt_pattern_exec(SLIST_FIRST(color->color_pattern),
                          MUTT_MATCH_FULL_ADDRESS, m, e, &cache))
    {
      ac_merge = merged_color_overlay(ac_merge, &color->attr_color);
    }
  }
 
  struct AttrColor *ac_normal = simple_color_get(MT_COLOR_NORMAL);
  if (ac_merge)
    ac_merge = merged_color_overlay(ac_normal, ac_merge);
  else
    ac_merge = ac_normal;
 
  e->attr_color = ac_merge;
}

Here is the call graph for this function:

Here is the caller graph for this function:

index_pager_init()

struct MuttWindow * index_pager_init

(

void

)

Allocate the Windows for the Index/Pager.

Return values

ptr	Dialog containing nested Windows

Definition at line 1413 of file dlg_index.c.

{
  struct MuttWindow *dlg = mutt_window_new(WT_DLG_INDEX, MUTT_WIN_ORIENT_HORIZONTAL,
                                           MUTT_WIN_SIZE_MAXIMISE, MUTT_WIN_SIZE_UNLIMITED,
                                           MUTT_WIN_SIZE_UNLIMITED);
 
  struct IndexSharedData *shared = index_shared_data_new();
  notify_set_parent(shared->notify, dlg->notify);
 
  dlg->wdata = shared;
  dlg->wdata_free = index_shared_data_free;
 
  const bool c_status_on_top = cs_subset_bool(NeoMutt->sub, "status_on_top");
 
  struct MuttWindow *panel_index = ipanel_new(c_status_on_top, shared);
  struct MuttWindow *panel_pager = ppanel_new(c_status_on_top, shared);
 
  mutt_window_add_child(dlg, panel_index);
  mutt_window_add_child(dlg, panel_pager);
 
  dlg->focus = panel_index;
 
  return dlg;
}

Here is the call graph for this function:

Here is the caller graph for this function:

dlg_change_folder()

void dlg_change_folder	(	struct MuttWindow *	dlg,
		struct Mailbox *	m
	)

Change the current folder, cautiously.

Parameters

dlg	Dialog holding the Index
m	Mailbox to change to

Definition at line 1443 of file dlg_index.c.

{
  if (!dlg || !m)
    return;
 
  struct IndexSharedData *shared = dlg->wdata;
  if (!shared)
    return;
 
  struct MuttWindow *panel_index = window_find_child(dlg, WT_INDEX);
  if (!panel_index)
    return;
 
  struct IndexPrivateData *priv = panel_index->wdata;
  if (!priv)
    return;
 
  change_folder_mailbox(priv->menu, m, &priv->oldcount, shared, false);
}

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

IndexHelp

const struct Mapping IndexHelp[]

static

Initial value:

= {
  
  { N_("Quit"),  OP_QUIT },
  { N_("Del"),   OP_DELETE },
  { N_("Undel"), OP_UNDELETE },
  { N_("Save"),  OP_SAVE },
  { N_("Mail"),  OP_MAIL },
  { N_("Reply"), OP_REPLY },
  { N_("Group"), OP_GROUP_REPLY },
  { N_("Help"),  OP_HELP },
  { NULL, 0 },
  
}

Help Bar for the Index dialog.

Definition at line 103 of file dlg_index.c.

IndexNewsHelp

const struct Mapping IndexNewsHelp[]

Initial value:

= {
  
  { N_("Quit"),     OP_QUIT },
  { N_("Del"),      OP_DELETE },
  { N_("Undel"),    OP_UNDELETE },
  { N_("Save"),     OP_SAVE },
  { N_("Post"),     OP_POST },
  { N_("Followup"), OP_FOLLOWUP },
  { N_("Catchup"),  OP_CATCHUP },
  { N_("Help"),     OP_HELP },
  { NULL, 0 },
  
}

Help Bar for the News Index dialog.

Definition at line 119 of file dlg_index.c.