GUI display a user-configurable status line. More...

#include "config.h"
#include <stdbool.h>
#include <stdio.h>
#include <sys/types.h>
#include "mutt/lib.h"
#include "config/lib.h"
#include "email/lib.h"
#include "core/lib.h"
#include "expando_status.h"
#include "expando/lib.h"
#include "menu/lib.h"
#include "postpone/lib.h"
#include "globals.h"
#include "mutt_mailbox.h"
#include "mutt_thread.h"
#include "muttlib.h"
#include "mview.h"
#include "shared_data.h"
#include "version.h"

Include dependency graph for expando_status.c:

Go to the source code of this file.

Functions
static void	index_mailbox_path (const struct ExpandoNode node, void data, MuttFormatFlags flags, struct Buffer *buf)
	Status: pathname of the mailbox - Implements get_string_t -.

static char *	get_sort_str (char *buf, size_t buflen, enum EmailSortType method)
	Get the sort method as a string.

static void	global_config_sort (const struct ExpandoNode node, void data, MuttFormatFlags flags, struct Buffer *buf)
	Status: Sorting mode - Implements get_string_t -.

static void	global_config_sort_aux (const struct ExpandoNode node, void data, MuttFormatFlags flags, struct Buffer *buf)
	Status: Aux sorting method - Implements get_string_t -.

static void	global_config_use_threads (const struct ExpandoNode node, void data, MuttFormatFlags flags, struct Buffer *buf)
	Status: Current threading mode - Implements get_string_t -.

static void	global_hostname (const struct ExpandoNode node, void data, MuttFormatFlags flags, struct Buffer *buf)
	Status: Local hostname - Implements get_string_t -.

static void	global_version (const struct ExpandoNode node, void data, MuttFormatFlags flags, struct Buffer *buf)
	Status: Version string - Implements get_string_t -.

static long	index_deleted_count_num (const struct ExpandoNode node, void data, MuttFormatFlags flags)
	Status: Number of deleted messages - Implements get_number_t -.

static void	index_description (const struct ExpandoNode node, void data, MuttFormatFlags flags, struct Buffer *buf)
	Status: Description of the mailbox - Implements get_string_t -.

static long	index_flagged_count_num (const struct ExpandoNode node, void data, MuttFormatFlags flags)
	Status: Number of flagged messages - Implements get_number_t -.

static long	index_limit_count_num (const struct ExpandoNode node, void data, MuttFormatFlags flags)
	Status: Number of messages - Implements get_number_t -.

static void	index_limit_pattern (const struct ExpandoNode node, void data, MuttFormatFlags flags, struct Buffer *buf)
	Status: Active limit pattern - Implements get_string_t -.

static void	index_limit_size (const struct ExpandoNode node, void data, MuttFormatFlags flags, struct Buffer *buf)
	Status: Size of the messages - Implements get_string_t -.

static long	index_limit_size_num (const struct ExpandoNode node, void data, MuttFormatFlags flags)
	Status: Size of the messages - Implements get_number_t -.

static void	index_mailbox_size (const struct ExpandoNode node, void data, MuttFormatFlags flags, struct Buffer *buf)
	Status: Size of the current mailbox - Implements get_string_t -.

static long	index_mailbox_size_num (const struct ExpandoNode node, void data, MuttFormatFlags flags)
	Status: Size of the current mailbox - Implements get_number_t -.

static long	index_message_count_num (const struct ExpandoNode node, void data, MuttFormatFlags flags)
	Status: Number of messages in the mailbox - Implements get_number_t -.

static long	index_new_count_num (const struct ExpandoNode node, void data, MuttFormatFlags flags)
	Status: Number of new messages - Implements get_number_t -.

static long	index_old_count_num (const struct ExpandoNode node, void data, MuttFormatFlags flags)
	Status: Number of old messages - Implements get_number_t -.

static long	index_postponed_count_num (const struct ExpandoNode node, void data, MuttFormatFlags flags)
	Status: Number of postponed messages - Implements get_number_t -.

static void	index_readonly (const struct ExpandoNode node, void data, MuttFormatFlags flags, struct Buffer *buf)
	Status: Modified/read-only flag - Implements get_string_t -.

static long	index_read_count_num (const struct ExpandoNode node, void data, MuttFormatFlags flags)
	Status: Number of read messages - Implements get_number_t -.

static long	index_tagged_count_num (const struct ExpandoNode node, void data, MuttFormatFlags flags)
	Status: Number of tagged messages - Implements get_number_t -.

static long	index_unread_count_num (const struct ExpandoNode node, void data, MuttFormatFlags flags)
	Status: Number of unread messages - Implements get_number_t -.

static long	index_unread_mailboxes_num (const struct ExpandoNode node, void data, MuttFormatFlags flags)
	Status: Number of mailboxes with new mail - Implements get_number_t -.

static void	menu_percentage (const struct ExpandoNode node, void data, MuttFormatFlags flags, struct Buffer *buf)
	Status: Percentage through index - Implements get_string_t -.

static long	menu_percentage_num (const struct ExpandoNode node, void data, MuttFormatFlags flags)
	Status: Percentage through index - Implements get_number_t -.

Variables
const struct Mapping	SortMethods []
	Sort methods for '$sort' for the index.

const struct ExpandoRenderCallback	StatusRenderCallbacks []
	Callbacks for Status Expandos.

Detailed Description

GUI display a user-configurable status line.

Authors

Michael R. Elkins
Richard Russon
Austin Ray
Pietro Cerutti
Eric Blake
Dennis Schön
Tóth János

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

Function Documentation

◆ get_sort_str()

static char * get_sort_str	(	char *	buf,
		size_t	buflen,
		enum EmailSortType	method )

static

Get the sort method as a string.

Parameters

buf	Buffer for the sort string
buflen	Length of the buffer
method	Sort method, see EmailSortType

Return values

ptr	Buffer pointer

Definition at line 67 of file expando_status.c.

{
  snprintf(buf, buflen, "%s%s%s", (method & SORT_REVERSE) ? "reverse-" : "",
           (method & SORT_LAST) ? "last-" : "",
           mutt_map_get_name(method & SORT_MASK, SortMethods));
  return buf;
}

Here is the call graph for this function:

Here is the caller graph for this function:

◆ global_hostname()

static void global_hostname	(	const struct ExpandoNode *	node,
		void *	data,
		MuttFormatFlags	flags,
		struct Buffer *	buf )

static

Status: Local hostname - Implements get_string_t -.

Definition at line 115 of file expando_status.c.

{
  const char *s = ShortHostname;
  buf_strcpy(buf, s);
}

Here is the call graph for this function:

◆ global_version()

static void global_version	(	const struct ExpandoNode *	node,
		void *	data,
		MuttFormatFlags	flags,
		struct Buffer *	buf )

static

Status: Version string - Implements get_string_t -.

Definition at line 125 of file expando_status.c.

{
  const char *s = mutt_make_version();
  buf_strcpy(buf, s);
}

Here is the call graph for this function:

Variable Documentation

◆ SortMethods

const struct Mapping SortMethods[]

extern

Sort methods for '$sort' for the index.

Definition at line 87 of file mutt_config.c.

                                     {
  // clang-format off
  { "date",          EMAIL_SORT_DATE },
  { "date-received", EMAIL_SORT_DATE_RECEIVED },
  { "from",          EMAIL_SORT_FROM },
  { "label",         EMAIL_SORT_LABEL },
  { "score",         EMAIL_SORT_SCORE },
  { "size",          EMAIL_SORT_SIZE },
  { "spam",          EMAIL_SORT_SPAM },
  { "subject",       EMAIL_SORT_SUBJECT },
  { "threads",       EMAIL_SORT_THREADS },
  { "to",            EMAIL_SORT_TO },
  { "unsorted",      EMAIL_SORT_UNSORTED },
  // Compatibility
  { "date-sent",     EMAIL_SORT_DATE },
  { "mailbox-order", EMAIL_SORT_UNSORTED },
  { NULL, 0 },
  // clang-format on
};

◆ StatusRenderCallbacks

const struct ExpandoRenderCallback StatusRenderCallbacks[]

Initial value:

= {
  
  { ED_GLOBAL, ED_GLO_CONFIG_SORT,        global_config_sort,        NULL },
  { ED_GLOBAL, ED_GLO_CONFIG_SORT_AUX,    global_config_sort_aux,    NULL },
  { ED_GLOBAL, ED_GLO_CONFIG_USE_THREADS, global_config_use_threads, NULL },
  { ED_GLOBAL, ED_GLO_HOSTNAME,           global_hostname,           NULL },
  { ED_GLOBAL, ED_GLO_VERSION,            global_version,            NULL },
  { ED_INDEX,  ED_IND_DELETED_COUNT,      NULL,                      index_deleted_count_num },
  { ED_INDEX,  ED_IND_DESCRIPTION,        index_description,         NULL },
  { ED_INDEX,  ED_IND_FLAGGED_COUNT,      NULL,                      index_flagged_count_num },
  { ED_INDEX,  ED_IND_LIMIT_COUNT,        NULL,                      index_limit_count_num },
  { ED_INDEX,  ED_IND_LIMIT_PATTERN,      index_limit_pattern,       NULL },
  { ED_INDEX,  ED_IND_LIMIT_SIZE,         index_limit_size,          index_limit_size_num },
  { ED_INDEX,  ED_IND_MAILBOX_PATH,       index_mailbox_path,        NULL },
  { ED_INDEX,  ED_IND_MAILBOX_SIZE,       index_mailbox_size,        index_mailbox_size_num },
  { ED_INDEX,  ED_IND_MESSAGE_COUNT,      NULL,                      index_message_count_num },
  { ED_INDEX,  ED_IND_NEW_COUNT,          NULL,                      index_new_count_num },
  { ED_INDEX,  ED_IND_OLD_COUNT,          NULL,                      index_old_count_num },
  { ED_INDEX,  ED_IND_POSTPONED_COUNT,    NULL,                      index_postponed_count_num },
  { ED_INDEX,  ED_IND_READONLY,           index_readonly,            NULL },
  { ED_INDEX,  ED_IND_READ_COUNT,         NULL,                      index_read_count_num },
  { ED_INDEX,  ED_IND_TAGGED_COUNT,       NULL,                      index_tagged_count_num },
  { ED_INDEX,  ED_IND_UNREAD_COUNT,       NULL,                      index_unread_count_num },
  { ED_INDEX,  ED_IND_UNREAD_MAILBOXES,   NULL,                      index_unread_mailboxes_num },
  { ED_MENU,   ED_MEN_PERCENTAGE,         menu_percentage,           menu_percentage_num },
  { -1, -1, NULL, NULL },
  
}

Callbacks for Status Expandos.

See also: StatusFormatDef, ExpandoDataGlobal, ExpandoDataIndex, ExpandoDataMenu

Definition at line 484 of file expando_status.c.

                                                             {
  // clang-format off
  { ED_GLOBAL, ED_GLO_CONFIG_SORT,        global_config_sort,        NULL },
  { ED_GLOBAL, ED_GLO_CONFIG_SORT_AUX,    global_config_sort_aux,    NULL },
  { ED_GLOBAL, ED_GLO_CONFIG_USE_THREADS, global_config_use_threads, NULL },
  { ED_GLOBAL, ED_GLO_HOSTNAME,           global_hostname,           NULL },
  { ED_GLOBAL, ED_GLO_VERSION,            global_version,            NULL },
  { ED_INDEX,  ED_IND_DELETED_COUNT,      NULL,                      index_deleted_count_num },
  { ED_INDEX,  ED_IND_DESCRIPTION,        index_description,         NULL },
  { ED_INDEX,  ED_IND_FLAGGED_COUNT,      NULL,                      index_flagged_count_num },
  { ED_INDEX,  ED_IND_LIMIT_COUNT,        NULL,                      index_limit_count_num },
  { ED_INDEX,  ED_IND_LIMIT_PATTERN,      index_limit_pattern,       NULL },
  { ED_INDEX,  ED_IND_LIMIT_SIZE,         index_limit_size,          index_limit_size_num },
  { ED_INDEX,  ED_IND_MAILBOX_PATH,       index_mailbox_path,        NULL },
  { ED_INDEX,  ED_IND_MAILBOX_SIZE,       index_mailbox_size,        index_mailbox_size_num },
  { ED_INDEX,  ED_IND_MESSAGE_COUNT,      NULL,                      index_message_count_num },
  { ED_INDEX,  ED_IND_NEW_COUNT,          NULL,                      index_new_count_num },
  { ED_INDEX,  ED_IND_OLD_COUNT,          NULL,                      index_old_count_num },
  { ED_INDEX,  ED_IND_POSTPONED_COUNT,    NULL,                      index_postponed_count_num },
  { ED_INDEX,  ED_IND_READONLY,           index_readonly,            NULL },
  { ED_INDEX,  ED_IND_READ_COUNT,         NULL,                      index_read_count_num },
  { ED_INDEX,  ED_IND_TAGGED_COUNT,       NULL,                      index_tagged_count_num },
  { ED_INDEX,  ED_IND_UNREAD_COUNT,       NULL,                      index_unread_count_num },
  { ED_INDEX,  ED_IND_UNREAD_MAILBOXES,   NULL,                      index_unread_mailboxes_num },
  { ED_MENU,   ED_MEN_PERCENTAGE,         menu_percentage,           menu_percentage_num },
  { -1, -1, NULL, NULL },
  // clang-format on
};

Functions

Variables

Detailed Description

Function Documentation

◆ get_sort_str()

◆ global_hostname()

◆ global_version()

Variable Documentation

◆ SortMethods

◆ StatusRenderCallbacks