index.c File Reference

Index Window. More...

#include "config.h"
#include <stdbool.h>
#include <stddef.h>
#include "mutt/lib.h"
#include "config/lib.h"
#include "email/lib.h"
#include "core/lib.h"
#include "alias/lib.h"
#include "gui/lib.h"
#include "attach/lib.h"
#include "color/lib.h"
#include "index/lib.h"
#include "menu/lib.h"
#include "postpone/lib.h"
#include "globals.h"
#include "module_data.h"
#include "muttlib.h"
#include "private_data.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.
static int	config_sort (const struct ConfigSubset *sub)
	React to changes to "sort".
static int	config_use_threads (const struct ConfigSubset *sub)
	React to changes to "use_threads".
void	index_adjust_sort_threads (const struct ConfigSubset *sub)
	Adjust use_threads/sort/sort_aux.
static int	config_reply_regex (struct MailboxView *mv)
	React to changes to $reply_regex.
static int	index_altern_observer (struct NotifyCallback *nc)
	Notification that an 'alternates' command has occurred - Implements observer_t -.
static int	index_attach_observer (struct NotifyCallback *nc)
	Notification that an 'attachments' command has occurred - Implements observer_t -.
static int	index_color_observer (struct NotifyCallback *nc)
	Notification that a Color has changed - Implements observer_t -.
static bool	config_check_sort (const char *option)
	Does this config option affect the Index sorting?
bool	config_check_index (const char *option)
	Does this config option affect the Index?
static int	index_config_observer (struct NotifyCallback *nc)
	Notification that a Config Variable has changed - Implements observer_t -.
static int	index_global_observer (struct NotifyCallback *nc)
	Notification that a Global event occurred - Implements observer_t -.
static int	index_index_observer (struct NotifyCallback *nc)
	Notification that the Index has changed - Implements observer_t -.
static int	index_menu_observer (struct NotifyCallback *nc)
	Notification that the Menu has changed - Implements observer_t -.
static int	index_score_observer (struct NotifyCallback *nc)
	Notification that a 'score' command has occurred - Implements observer_t -.
static int	index_subjectrx_observer (struct NotifyCallback *nc)
	Notification that a 'subject-regex' command has occurred - Implements observer_t -.
static int	index_window_observer (struct NotifyCallback *nc)
	Notification that a Window has changed - Implements observer_t -.
static int	index_recalc (struct MuttWindow *win)
	Recalculate the Index display - Implements MuttWindow::recalc() -.
static int	index_repaint (struct MuttWindow *win)
	Repaint the Index display - Implements MuttWindow::repaint() -.
struct MuttWindow *	index_window_new (struct IndexPrivateData *priv)
	Create a new Index Window (list of Emails).
struct MailboxView *	get_current_mailbox_view (void)
	Get the current Mailbox view.
struct Mailbox *	get_current_mailbox (void)
	Get the current Mailbox.

Detailed Description

Index Window.

Authors

• Eric Blake
• Richard Russon
• Pietro Cerutti
• Alejandro Colomar

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()

void sort_use_threads_warn ( void )

static

Alert the user to odd $sort settings.

Definition at line 95 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()

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 112 of file index.c.

{
  const enum EmailSortType c_sort = cs_subset_sort(sub, "sort");
  const unsigned char c_use_threads = cs_subset_enum(sub, "use_threads");
 
  if (((c_sort & SORT_MASK) != EMAIL_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
   * EMAIL_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.
     */
    enum EmailSortType 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()

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 160 of file index.c.

{
  const enum EmailSortType c_sort = cs_subset_sort(sub, "sort");
  const unsigned char c_use_threads = cs_subset_enum(sub, "use_threads");
 
  if (((c_sort & SORT_MASK) != EMAIL_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 enum EmailSortType 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:

index_adjust_sort_threads()

void index_adjust_sort_threads

(

const struct ConfigSubset *

sub

)

Adjust use_threads/sort/sort_aux.

Parameters

sub	the config subset that was just updated

Definition at line 184 of file index.c.

{
  /* For lack of a better way, we fake a "set use_threads" */
  config_use_threads(sub);
}

Here is the call graph for this function:

Here is the caller graph for this function:

config_reply_regex()

int config_reply_regex ( struct MailboxView * mv )

static

React to changes to $reply_regex.

Parameters

mv	Mailbox View

Return values

0	Successfully handled
-1	Error

Definition at line 196 of file index.c.

{
  if (!mv || !mv->mailbox)
    return 0;
 
  struct Mailbox *m = mv->mailbox;
 
  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;
 
    mutt_env_set_subject(env, 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:

config_check_sort()

bool config_check_sort ( const char * option )

static

Does this config option affect the Index sorting?

Parameters

option

Config option

Return values

true	Index may need resorting

< Resort the mailbox

< Resort from scratch

< Resort subthreads

Definition at line 316 of file index.c.

{
  const int R_RESORT = (1 << 0);      
  const int R_RESORT_INIT = (1 << 1); 
  const int R_RESORT_SUB = (1 << 2);  
 
  static const struct Mapping sort_options[] = {
    // clang-format off
    { "duplicate_threads", R_RESORT | R_RESORT_INIT },
    { "reply_regex",       R_RESORT                 },
    { "sort",              R_RESORT                 },
    { "sort_aux",          R_RESORT | R_RESORT_SUB  },
    { "sort_re",           R_RESORT | R_RESORT_INIT },
    { "strict_threads",    R_RESORT | R_RESORT_INIT },
    { "thread_received",   R_RESORT | R_RESORT_INIT },
    { "use_threads",       R_RESORT                 },
    { NULL, 0 },
    // clang-format on
  };
 
  int flags = mutt_map_get_value(option, sort_options);
  if (flags < 0)
    return false;
 
  if (flags & R_RESORT)
    OptNeedResort = true;
  if (flags & R_RESORT_INIT)
    OptResortInit = true;
  if (flags & R_RESORT_SUB)
    OptSortSubthreads = true;
 
  return true;
}

Here is the call graph for this function:

Here is the caller graph for this function:

config_check_index()

bool config_check_index

(

const char *

option

)

Does this config option affect the Index?

Parameters

option

Config option

Return values

true	Index may need redrawing

Definition at line 355 of file index.c.

{
  static const char *index_options[] = {
    "ascii_chars",        "crypt_chars",
    "flag_chars",         "from_chars",
    "group_index_format", "hide_limited",
    "hide_missing",       "hide_thread_subject",
    "hide_top_limited",   "hide_top_missing",
    "imap_headers",       "index_format",
    "mark_old",           "mbox",
    "narrow_tree",        "postponed",
    "real_name",          "reverse_alias",
    "reverse_name",       "reverse_real_name",
    "status_chars",       "status_format",
    "to_chars",           "ts_enabled",
    "ts_icon_format",     "ts_status_format"
  };
 
  for (size_t i = 0; i < countof(index_options); i++)
  {
    if (mutt_str_equal(option, index_options[i]))
      return true;
  }
 
  return false;
}

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 IndexPrivateData *

priv

)

Create a new Index Window (list of Emails).

Parameters

priv	Private Index data

Return values

ptr	New Window

Definition at line 657 of file index.c.

{
  struct IndexModuleData *mod_data = neomutt_get_module_data(NeoMutt, MODULE_ID_INDEX);
  ASSERT(mod_data);
 
  struct MuttWindow *win = menu_window_new(mod_data->md_index, NeoMutt->sub);
  win->recalc = index_recalc;
  win->repaint = index_repaint;
 
  struct Menu *menu = win->wdata;
  menu->mdata = priv;
  menu->mdata_free = NULL; // Menu doesn't own the data
  priv->menu = menu;
 
  mutt_color_observer_add(index_color_observer, win);
  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->sub->notify, NT_CONFIG, index_config_observer, win);
  notify_observer_add(NeoMutt->notify, NT_GLOBAL, index_global_observer, win);
  notify_observer_add(priv->shared->notify, NT_ALL, index_index_observer, win);
  notify_observer_add(menu->notify, NT_MENU, index_menu_observer, win);
  notify_observer_add(NeoMutt->notify, NT_SCORE, index_score_observer, win);
  notify_observer_add(NeoMutt->notify, NT_SUBJECTRX, index_subjectrx_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:

get_current_mailbox_view()

struct MailboxView * get_current_mailbox_view

(

void

)

Get the current Mailbox view.

Return values

ptr	Current Mailbox view

Search for the last (most recent) dialog that has an Index. Then return the Mailbox from its shared data.

Definition at line 692 of file index.c.

{
  struct GuiModuleData *mod_data = neomutt_get_module_data(NeoMutt, MODULE_ID_GUI);
  if (!mod_data || !mod_data->all_dialogs_window)
    return NULL;
 
  struct MuttWindow **wp = NULL;
  ARRAY_FOREACH_REVERSE(wp, &mod_data->all_dialogs_window->children)
  {
    struct MuttWindow *win = window_find_child(*wp, WT_DLG_INDEX);
    if (win)
    {
      struct IndexSharedData *shared = win->wdata;
      return shared->mailbox_view;
    }
 
    win = window_find_child(*wp, WT_DLG_POSTPONE);
    if (win)
    {
      return postpone_get_mailbox_view(win);
    }
  }
 
  return NULL;
}

Here is the call graph for this function:

Here is the caller graph for this function:

get_current_mailbox()

struct Mailbox * get_current_mailbox

(

void

)

Get the current Mailbox.

Return values

ptr	Current Mailbox

Search for the last (most recent) dialog that has an Index. Then return the Mailbox from its shared data.

Definition at line 725 of file index.c.

{
  struct MailboxView *mv = get_current_mailbox_view();
  if (mv)
    return mv->mailbox;
 
  return NULL;
}

Here is the call graph for this function:

Here is the caller graph for this function: