index.c File Reference

Index Window. More...

#include "config.h"
#include <assert.h>
#include <stdbool.h>
#include "mutt/lib.h"
#include "config/lib.h"
#include "email/lib.h"
#include "core/lib.h"
#include "gui/lib.h"
#include "menu/lib.h"
#include "alternates.h"
#include "attachments.h"
#include "mutt_thread.h"
#include "muttlib.h"
#include "options.h"
#include "private_data.h"
#include "score.h"
#include "shared_data.h"
#include "subjectrx.h"

Include dependency graph for index.c:

Go to the source code of this file.

Functions
static void	sort_use_threads_warn (void)
	alert the user to odd $sort settings More...
static int	config_sort (const struct ConfigSubset *sub)
	React to changes to "sort". More...
static int	config_use_threads (const struct ConfigSubset *sub)
	React to changes to "use_threads". More...
static int	config_reply_regex (struct MuttWindow *dlg)
	React to changes to $reply_regex. More...
static int	index_altern_observer (struct NotifyCallback *nc)
	Notification that an 'alternates' command has occurred - Implements observer_t. More...
static int	index_attach_observer (struct NotifyCallback *nc)
	Notification that an 'attachments' command has occurred - Implements observer_t. More...
static int	index_color_observer (struct NotifyCallback *nc)
	Notification that a Color has changed - Implements observer_t. More...
static int	index_config_observer (struct NotifyCallback *nc)
	Notification that a Config Variable has changed - Implements observer_t. More...
static int	index_score_observer (struct NotifyCallback *nc)
	Notification that a 'score' command has occurred - Implements observer_t. More...
static int	index_subjrx_observer (struct NotifyCallback *nc)
	Notification that a 'subjectrx' command has occurred - Implements observer_t. More...
static int	index_window_observer (struct NotifyCallback *nc)
	Notification that a Window has changed - Implements observer_t. More...
struct MuttWindow *	index_window_new (struct IndexSharedData *shared, struct IndexPrivateData *priv)
	Create a new Index Window (list of Emails) More...

Detailed Description

Index Window.

Authors

• Richard Russon

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

Function Documentation

sort_use_threads_warn()

static void sort_use_threads_warn ( void  )

static

alert the user to odd $sort settings

Definition at line 89 of file index.c.

{
  static bool warned = false;
  if (!warned)
  {
    mutt_warning(
        _("Changing threaded display should prefer $use_threads over $sort"));
    warned = true;
    mutt_sleep(0);
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

config_sort()

static int config_sort ( const struct ConfigSubset *  sub )

static

React to changes to "sort".

Parameters

sub	the config subset that was just updated

Return values

0	Successfully handled
-1	Error

Definition at line 107 of file index.c.

{
  const short c_sort = cs_subset_sort(sub, "sort");
  const unsigned char c_use_threads = cs_subset_enum(sub, "use_threads");

  if (((c_sort & SORT_MASK) != SORT_THREADS) || (c_use_threads == UT_UNSET))
    return 0;

  sort_use_threads_warn();

  /* Note: changing a config variable here kicks off a second round of
   * observers before the first round has completed. Be careful that
   * changes made here do not cause an infinite loop of toggling
   * adjustments - the early exit above when $sort no longer uses
   * SORT_THREADS ends the recursion.
   */
  int rc;
  if ((c_use_threads == UT_FLAT) ||
      (!(c_sort & SORT_REVERSE) == (c_use_threads == UT_REVERSE)))
  {
    /* If we were flat or the user wants to change thread
     * directions, then leave $sort alone for now and change
     * $use_threads to match the desired outcome.  The 2nd-level
     * observer for $use_threads will then adjust $sort, and our
     * 3rd-level observer for $sort will be a no-op.
     */
    rc = cs_subset_str_native_set(
        sub, "use_threads", (c_sort & SORT_REVERSE) ? UT_REVERSE : UT_THREADS, NULL);
  }
  else
  {
    /* We were threaded, and the user still wants the same thread
     * direction. Adjust $sort based on $sort_aux, and the 2nd-level
     * observer for $sort will be a no-op.
     */
    short c_sort_aux = cs_subset_sort(sub, "sort_aux");
    c_sort_aux ^= (c_sort & SORT_REVERSE);
    rc = cs_subset_str_native_set(sub, "sort", c_sort_aux, NULL);
  }
  return (CSR_RESULT(rc) == CSR_SUCCESS) ? 0 : -1;
}

Here is the call graph for this function:

Here is the caller graph for this function:

config_use_threads()

static int config_use_threads ( const struct ConfigSubset *  sub )

static

React to changes to "use_threads".

Parameters

sub	the config subset that was just updated

Return values

0	Successfully handled
-1	Error

Definition at line 155 of file index.c.

{
  const short c_sort = cs_subset_sort(sub, "sort");
  const unsigned char c_use_threads = cs_subset_enum(sub, "use_threads");

  if (((c_sort & SORT_MASK) != SORT_THREADS) || (c_use_threads == UT_UNSET))
    return 0;

  sort_use_threads_warn();

  /* Note: changing a config variable here kicks off a second round of
   * observers before the first round has completed. But since we
   * aren't setting $sort to threads, the 2nd-level observer will be a
   * no-op.
   */
  const short c_sort_aux = cs_subset_sort(sub, "sort_aux");
  int rc = cs_subset_str_native_set(sub, "sort", c_sort_aux, NULL);
  return (CSR_RESULT(rc) == CSR_SUCCESS) ? 0 : -1;
}

Here is the call graph for this function:

Here is the caller graph for this function:

config_reply_regex()

static int config_reply_regex ( struct MuttWindow *  dlg )

static

React to changes to $reply_regex.

Parameters

dlg	Index Dialog

Return values

0	Successfully handled
-1	Error

Definition at line 181 of file index.c.

{
  struct IndexSharedData *shared = dlg->wdata;
  struct Mailbox *m = shared->mailbox;
  if (!m)
    return 0;

  regmatch_t pmatch[1];

  for (int i = 0; i < m->msg_count; i++)
  {
    struct Email *e = m->emails[i];
    if (!e)
      break;
    struct Envelope *env = e->env;
    if (!env || !env->subject)
      continue;

    const struct Regex *c_reply_regex =
        cs_subset_regex(NeoMutt->sub, "reply_regex");
    if (mutt_regex_capture(c_reply_regex, env->subject, 1, pmatch))
    {
      env->real_subj = env->subject + pmatch[0].rm_eo;
      continue;
    }

    env->real_subj = env->subject;
  }

  OptResortInit = true; /* trigger a redraw of the index */
  return 0;
}

Here is the call graph for this function:

Here is the caller graph for this function:

index_altern_observer()

static int index_altern_observer ( struct NotifyCallback *  nc )

static

Notification that an 'alternates' command has occurred - Implements observer_t.

Definition at line 217 of file index.c.

{
  if ((nc->event_type != NT_ALTERN) || !nc->global_data)
    return -1;

  struct MuttWindow *dlg = nc->global_data;
  struct IndexSharedData *shared = dlg->wdata;

  mutt_alternates_reset(shared->mailbox);
  mutt_debug(LL_DEBUG5, "alternates done\n");
  return 0;
}

Here is the call graph for this function:

Here is the caller graph for this function:

index_attach_observer()

static int index_attach_observer ( struct NotifyCallback *  nc )

static

Notification that an 'attachments' command has occurred - Implements observer_t.

Definition at line 233 of file index.c.

{
  if ((nc->event_type != NT_ATTACH) || !nc->global_data)
    return -1;

  struct MuttWindow *dlg = nc->global_data;
  struct IndexSharedData *shared = dlg->wdata;

  mutt_attachments_reset(shared->mailbox);
  mutt_debug(LL_DEBUG5, "attachments done\n");
  return 0;
}

Here is the call graph for this function:

Here is the caller graph for this function:

index_color_observer()

static int index_color_observer ( struct NotifyCallback *  nc )

static

Notification that a Color has changed - Implements observer_t.

Definition at line 249 of file index.c.

{
  if ((nc->event_type != NT_COLOR) || !nc->global_data || !nc->event_data)
    return -1;

  struct EventColor *ev_c = nc->event_data;

  const int c = ev_c->color;

  bool simple = (c == MT_COLOR_INDEX_COLLAPSED) || (c == MT_COLOR_INDEX_DATE) ||
                (c == MT_COLOR_INDEX_LABEL) || (c == MT_COLOR_INDEX_NUMBER) ||
                (c == MT_COLOR_INDEX_SIZE) || (c == MT_COLOR_INDEX_TAGS);

  bool lists = (c == MT_COLOR_INDEX) || (c == MT_COLOR_INDEX_AUTHOR) ||
               (c == MT_COLOR_INDEX_FLAGS) || (c == MT_COLOR_INDEX_SUBJECT) ||
               (c == MT_COLOR_INDEX_TAG);

  // The changes aren't relevant to the index menu
  if (!simple && !lists)
    return 0;

  struct MuttWindow *win_index = nc->global_data;
  struct MuttWindow *dlg = dialog_find(win_index);
  struct IndexSharedData *shared = dlg->wdata;

  struct Mailbox *m = shared->mailbox;
  if (!m)
    return 0;

  // Colour deleted from a list
  if ((nc->event_subtype == NT_COLOR_RESET) && lists)
  {
    // Force re-caching of index colours
    for (int i = 0; i < m->msg_count; i++)
    {
      struct Email *e = m->emails[i];
      if (!e)
        break;
      e->pair = 0;
    }
  }

  struct MuttWindow *panel_index = window_find_child(dlg, WT_INDEX);
  struct IndexPrivateData *priv = panel_index->wdata;
  struct Menu *menu = priv->menu;
  menu->redraw = MENU_REDRAW_FULL;
  mutt_debug(LL_DEBUG5, "color done, request MENU_REDRAW_FULL\n");

  return 0;
}

Here is the call graph for this function:

Here is the caller graph for this function:

index_config_observer()

static int index_config_observer ( struct NotifyCallback *  nc )

static

Notification that a Config Variable has changed - Implements observer_t.

Definition at line 303 of file index.c.

{
  if ((nc->event_type != NT_CONFIG) || !nc->global_data || !nc->event_data)
    return -1;

  struct EventConfig *ev_c = nc->event_data;
  struct MuttWindow *dlg = nc->global_data;
  const struct ConfigDef *cdef = ev_c->he->data;
  ConfigRedrawFlags flags = cdef->type & R_REDRAW_MASK;

  if (flags & R_RESORT_SUB)
    OptSortSubthreads = true;
  if (flags & R_RESORT)
    OptNeedResort = true;
  if (flags & R_RESORT_INIT)
    OptResortInit = true;

  if (mutt_str_equal(ev_c->name, "reply_regex"))
  {
    config_reply_regex(dlg);
    mutt_debug(LL_DEBUG5, "config done\n");
  }
  else if (mutt_str_equal(ev_c->name, "sort"))
  {
    config_sort(ev_c->sub);
    mutt_debug(LL_DEBUG5, "config done\n");
  }
  else if (mutt_str_equal(ev_c->name, "use_threads"))
  {
    config_use_threads(ev_c->sub);
    mutt_debug(LL_DEBUG5, "config done\n");
  }

  return 0;
}

Here is the call graph for this function:

Here is the caller graph for this function:

index_score_observer()

static int index_score_observer ( struct NotifyCallback *  nc )

static

Notification that a 'score' command has occurred - Implements observer_t.

Definition at line 342 of file index.c.

{
  if ((nc->event_type != NT_SCORE) || !nc->global_data)
    return -1;

  struct MuttWindow *dlg = nc->global_data;
  struct IndexSharedData *shared = dlg->wdata;

  struct Mailbox *m = shared->mailbox;
  if (!m)
    return 0;

  for (int i = 0; i < m->msg_count; i++)
  {
    struct Email *e = m->emails[i];
    if (!e)
      break;

    mutt_score_message(m, e, true);
    e->pair = 0; // Force recalc of colour
  }

  mutt_debug(LL_DEBUG5, "score done\n");
  return 0;
}

Here is the call graph for this function:

Here is the caller graph for this function:

index_subjrx_observer()

static int index_subjrx_observer ( struct NotifyCallback *  nc )

static

Notification that a 'subjectrx' command has occurred - Implements observer_t.

Definition at line 371 of file index.c.

{
  if ((nc->event_type != NT_SUBJRX) || !nc->global_data)
    return -1;

  struct MuttWindow *dlg = nc->global_data;
  struct IndexSharedData *shared = dlg->wdata;

  subjrx_clear_mods(shared->mailbox);
  mutt_debug(LL_DEBUG5, "subjectrx done\n");
  return 0;
}

Here is the call graph for this function:

Here is the caller graph for this function:

index_window_observer()

static int index_window_observer ( struct NotifyCallback *  nc )

static

Notification that a Window has changed - Implements observer_t.

Definition at line 387 of file index.c.

{
  if ((nc->event_type != NT_WINDOW) || !nc->global_data || !nc->event_data)
    return -1;

  if (nc->event_subtype != NT_WINDOW_DELETE)
    return 0;

  struct MuttWindow *win = nc->global_data;
  struct EventWindow *ev_w = nc->event_data;
  if (ev_w->win != win)
    return 0;

  notify_observer_remove(NeoMutt->notify, index_altern_observer, win);
  notify_observer_remove(NeoMutt->notify, index_attach_observer, win);
  notify_observer_remove(NeoMutt->notify, index_color_observer, win);
  notify_observer_remove(NeoMutt->notify, index_config_observer, win);
  notify_observer_remove(NeoMutt->notify, index_score_observer, win);
  notify_observer_remove(NeoMutt->notify, index_subjrx_observer, win);
  notify_observer_remove(win->notify, index_window_observer, win);

  mutt_debug(LL_DEBUG5, "window delete done\n");
  return 0;
}

Here is the call graph for this function:

Here is the caller graph for this function:

index_window_new()

struct MuttWindow* index_window_new	(	struct IndexSharedData *	shared,
		struct IndexPrivateData *	priv
	)

Create a new Index Window (list of Emails)

Return values

ptr	New Window

Definition at line 416 of file index.c.

{
  struct MuttWindow *win = menu_new_window(MENU_MAIN, NeoMutt->sub);

  struct Menu *menu = win->wdata;
  menu->mdata = priv;
  priv->menu = menu;

  notify_observer_add(NeoMutt->notify, NT_ALTERN, index_altern_observer, win);
  notify_observer_add(NeoMutt->notify, NT_ATTACH, index_attach_observer, win);
  notify_observer_add(NeoMutt->notify, NT_COLOR, index_color_observer, win);
  notify_observer_add(NeoMutt->notify, NT_CONFIG, index_config_observer, win);
  notify_observer_add(NeoMutt->notify, NT_SCORE, index_score_observer, win);
  notify_observer_add(NeoMutt->notify, NT_SUBJRX, index_subjrx_observer, win);
  notify_observer_add(win->notify, NT_WINDOW, index_window_observer, win);

  return win;
}

Here is the call graph for this function:

Here is the caller graph for this function: