status.c File Reference

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

#include "config.h"
#include <stdbool.h>
#include <stdio.h>
#include "mutt/lib.h"
#include "config/lib.h"
#include "core/lib.h"
#include "status.h"
#include "expando/lib.h"
#include "index/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 dependency graph for status.c:

Go to the source code of this file.

Data Structures
struct	MenuStatusLineData
	Data for creating a Menu line. More...

Functions
void	status_f (const struct ExpandoNode *node, void *data, MuttFormatFlags flags, int max_cols, struct Buffer *buf)
	Status: pathname of the mailbox - Implements ExpandoRenderData::get_string() -.
static char *	get_sort_str (char *buf, size_t buflen, enum SortType method)
	Get the sort method as a string.
void	status_r (const struct ExpandoNode *node, void *data, MuttFormatFlags flags, int max_cols, struct Buffer *buf)
	Status: Modified/read-only flag - Implements ExpandoRenderData::get_string() -.
void	status_D (const struct ExpandoNode *node, void *data, MuttFormatFlags flags, int max_cols, struct Buffer *buf)
	Status: Description of the mailbox - Implements ExpandoRenderData::get_string() -.
long	status_M_num (const struct ExpandoNode *node, void *data, MuttFormatFlags flags)
	Status: Number of messages - Implements ExpandoRenderData::get_number() -.
long	status_m_num (const struct ExpandoNode *node, void *data, MuttFormatFlags flags)
	Status: Number of messages in the mailbox - Implements ExpandoRenderData::get_number() -.
long	status_n_num (const struct ExpandoNode *node, void *data, MuttFormatFlags flags)
	Status: Number of new messages - Implements ExpandoRenderData::get_number() -.
long	status_o_num (const struct ExpandoNode *node, void *data, MuttFormatFlags flags)
	Status: Number of old messages - Implements ExpandoRenderData::get_number() -.
long	status_d_num (const struct ExpandoNode *node, void *data, MuttFormatFlags flags)
	Status: Number of deleted messages - Implements ExpandoRenderData::get_number() -.
long	status_F_num (const struct ExpandoNode *node, void *data, MuttFormatFlags flags)
	Status: Number of flagged messages - Implements ExpandoRenderData::get_number() -.
long	status_t_num (const struct ExpandoNode *node, void *data, MuttFormatFlags flags)
	Status: Number of tagged messages - Implements ExpandoRenderData::get_number() -.
long	status_p_num (const struct ExpandoNode *node, void *data, MuttFormatFlags flags)
	Status: Number of postponed messages - Implements ExpandoRenderData::get_number() -.
long	status_b_num (const struct ExpandoNode *node, void *data, MuttFormatFlags flags)
	Status: Number of mailboxes with new mail - Implements ExpandoRenderData::get_number() -.
long	status_l_num (const struct ExpandoNode *node, void *data, MuttFormatFlags flags)
	Status: Size of the current mailbox - Implements ExpandoRenderData::get_number() -.
void	status_l (const struct ExpandoNode *node, void *data, MuttFormatFlags flags, int max_cols, struct Buffer *buf)
	Status: Size of the current mailbox - Implements ExpandoRenderData::get_string() -.
void	status_T (const struct ExpandoNode *node, void *data, MuttFormatFlags flags, int max_cols, struct Buffer *buf)
	Status: Current threading mode - Implements ExpandoRenderData::get_string() -.
void	status_s (const struct ExpandoNode *node, void *data, MuttFormatFlags flags, int max_cols, struct Buffer *buf)
	Status: Sorting mode - Implements ExpandoRenderData::get_string() -.
void	status_S (const struct ExpandoNode *node, void *data, MuttFormatFlags flags, int max_cols, struct Buffer *buf)
	Status: Aux sorting method - Implements ExpandoRenderData::get_string() -.
long	status_P_num (const struct ExpandoNode *node, void *data, MuttFormatFlags flags)
	Status: Percentage through index - Implements ExpandoRenderData::get_number() -.
void	status_P (const struct ExpandoNode *node, void *data, MuttFormatFlags flags, int max_cols, struct Buffer *buf)
	Status: Percentage through index - Implements ExpandoRenderData::get_string() -.
void	status_h (const struct ExpandoNode *node, void *data, MuttFormatFlags flags, int max_cols, struct Buffer *buf)
	Status: Local hostname - Implements ExpandoRenderData::get_string() -.
long	status_L_num (const struct ExpandoNode *node, void *data, MuttFormatFlags flags)
	Status: Size of the messages - Implements ExpandoRenderData::get_number() -.
void	status_L (const struct ExpandoNode *node, void *data, MuttFormatFlags flags, int max_cols, struct Buffer *buf)
	Status: Size of the messages - Implements ExpandoRenderData::get_string() -.
long	status_R_num (const struct ExpandoNode *node, void *data, MuttFormatFlags flags)
	Status: Number of read messages - Implements ExpandoRenderData::get_number() -.
long	status_u_num (const struct ExpandoNode *node, void *data, MuttFormatFlags flags)
	Status: Number of unread messages - Implements ExpandoRenderData::get_number() -.
void	status_v (const struct ExpandoNode *node, void *data, MuttFormatFlags flags, int max_cols, struct Buffer *buf)
	Status: Version string - Implements ExpandoRenderData::get_string() -.
void	status_V (const struct ExpandoNode *node, void *data, MuttFormatFlags flags, int max_cols, struct Buffer *buf)
	Status: Active limit pattern - Implements ExpandoRenderData::get_string() -.
void	menu_status_line (struct Buffer *buf, struct IndexSharedData *shared, struct Menu *menu, int max_cols, const struct Expando *exp)
	Create the status line.

Variables
const struct ExpandoRenderData	StatusRenderData []
	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 status.c.

Function Documentation

get_sort_str()

static char * get_sort_str ( char *  buf, size_t  buflen, enum SortType  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 SortType

Return values

ptr	Buffer pointer

Definition at line 64 of file 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:

menu_status_line()

void menu_status_line	(	struct Buffer *	buf,
		struct IndexSharedData *	shared,
		struct Menu *	menu,
		int	max_cols,
		const struct Expando *	exp
	)

Create the status line.

Parameters

[out]	buf	Buffer in which to save string
[in]	shared	Shared Index data
[in]	menu	Current menu
[in]	max_cols	Maximum number of columns to use (-1 means unlimited)
[in]	exp	Expando

See also

status_format_str()

Definition at line 495 of file status.c.

{
  struct MenuStatusLineData data = { shared, menu };
 
  expando_render(exp, StatusRenderData, &data, MUTT_FORMAT_NO_FLAGS, max_cols, buf);
}

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

StatusRenderData

const struct ExpandoRenderData StatusRenderData

Initial value:

= {
  
  { ED_INDEX,  ED_IND_UNREAD_MAILBOXES,NULL,     status_b_num },
  { ED_INDEX,  ED_IND_DELETED_COUNT,   NULL,     status_d_num },
  { ED_INDEX,  ED_IND_DESCRIPTION,     status_D, NULL },
  { ED_INDEX,  ED_IND_FLAGGED_COUNT,   NULL,     status_F_num },
  { ED_INDEX,  ED_IND_MAILBOX_PATH,    status_f, NULL },
  { ED_GLOBAL, ED_GLO_HOSTNAME,        status_h, NULL },
  { ED_INDEX,  ED_IND_LIMIT_SIZE,      status_L, status_L_num },
  { ED_INDEX,  ED_IND_MAILBOX_SIZE,    status_l, status_l_num },
  { ED_INDEX,  ED_IND_LIMIT_COUNT,     NULL,     status_M_num },
  { ED_INDEX,  ED_IND_MESSAGE_COUNT,   NULL,     status_m_num },
  { ED_INDEX,  ED_IND_NEW_COUNT,       NULL,     status_n_num },
  { ED_INDEX,  ED_IND_OLD_COUNT,       NULL,     status_o_num },
  { ED_MENU,   ED_MEN_PERCENTAGE,      status_P, status_P_num },
  { ED_INDEX,  ED_IND_POSTPONED_COUNT, NULL,     status_p_num },
  { ED_INDEX,  ED_IND_READ_COUNT,      NULL,     status_R_num },
  { ED_INDEX,  ED_IND_READONLY,        status_r, NULL },
  { ED_GLOBAL, ED_GLO_SORT,            status_s, NULL },
  { ED_GLOBAL, ED_GLO_SORT_AUX,        status_S, NULL },
  { ED_INDEX,  ED_IND_TAGGED_COUNT,    NULL,     status_t_num },
  { ED_GLOBAL, ED_GLO_USE_THREADS,     status_T, NULL },
  { ED_INDEX,  ED_IND_UNREAD_COUNT,    NULL,     status_u_num },
  { ED_INDEX,  ED_IND_LIMIT_PATTERN,   status_V, NULL },
  { ED_GLOBAL, ED_GLO_VERSION,         status_v, NULL },
  { -1, -1, NULL, NULL },
  
}

Callbacks for Status Expandos.

See also

StatusFormatDef, ExpandoDataGlobal, ExpandoDataIndex, ExpandoDataMenu

Definition at line 55 of file status.c.