status.c File Reference

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

#include "config.h"
#include <stdbool.h>
#include <stdint.h>
#include <stdio.h>
#include <sys/types.h>
#include "mutt/lib.h"
#include "config/lib.h"
#include "core/lib.h"
#include "status.h"
#include "index/lib.h"
#include "menu/lib.h"
#include "context.h"
#include "format_flags.h"
#include "mutt_globals.h"
#include "mutt_mailbox.h"
#include "muttlib.h"
#include "options.h"
#include "protos.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
static char *	get_sort_str (char *buf, size_t buflen, enum SortType method)
	Get the sort method as a string. More...
static const char *	status_format_str (char *buf, size_t buflen, size_t col, int cols, char op, const char *src, const char *prec, const char *if_str, const char *else_str, intptr_t data, MuttFormatFlags flags)
	Create the status bar string - Implements format_t. More...
void	menu_status_line (char *buf, size_t buflen, struct IndexSharedData *shared, struct Menu *menu, int cols, const char *fmt)
	Create the status line. More...

Detailed Description

GUI display a user-configurable status line.

Authors

• Michael R. Elkins

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 55 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:

status_format_str()

static const char* status_format_str ( char *  buf, size_t  buflen, size_t  col, int  cols, char  op, const char *  src, const char *  prec, const char *  if_str, const char *  else_str, intptr_t  data, MuttFormatFlags  flags  )

static

Create the status bar string - Implements format_t.

Expando	Description
%b	Number of incoming folders with unread messages
%D	Description of the mailbox
%d	Number of deleted messages
%f	Full mailbox path
%F	Number of flagged messages
%h	Hostname
%l	Length of mailbox (in bytes)
%L	Size (in bytes) of the messages shown (or limited)
%M	Number of messages shown (virtual message count when limiting)
%m	Total number of messages
%n	Number of new messages
%o	Number of old unread messages
%p	Number of postponed messages
%P	Percent of way through index
%R	Number of read messages
%r	Readonly/wontwrite/changed flag
%S	Current aux sorting method ($sort_aux)
%s	Current sorting method ($sort)
%t	Number of tagged messages
%u	Number of unread messages
%V	Currently active limit pattern
%v	NeoMutt version

Definition at line 100 of file status.c.

{
  char fmt[128], tmp[128];
  bool optional = (flags & MUTT_FORMAT_OPTIONAL);
  struct MenuStatusLineData *msld = (struct MenuStatusLineData *) data;
  struct IndexSharedData *shared = msld->shared;
  struct Context *ctx = shared->ctx;
  struct Mailbox *m = shared->mailbox;
  struct Menu *menu = msld->menu;

  *buf = '\0';
  switch (op)
  {
    case 'b':
    {
      const int num = mutt_mailbox_check(m, 0);
      if (!optional)
      {
        snprintf(fmt, sizeof(fmt), "%%%sd", prec);
        snprintf(buf, buflen, fmt, num);
      }
      else if (num == 0)
        optional = false;
      break;
    }

    case 'd':
    {
      const int num = m ? m->msg_deleted : 0;
      if (!optional)
      {
        snprintf(fmt, sizeof(fmt), "%%%sd", prec);
        snprintf(buf, buflen, fmt, num);
      }
      else if (num == 0)
        optional = false;
      break;
    }

    case 'D':
      // If there's a descriptive name, use it. Otherwise, fall-through
      if (m && m->name)
      {
        mutt_str_copy(tmp, m->name, sizeof(tmp));
        snprintf(fmt, sizeof(fmt), "%%%ss", prec);
        snprintf(buf, buflen, fmt, tmp);
        break;
      }
    /* fallthrough */
    case 'f':
#ifdef USE_COMP_MBOX
      if (m && m->compress_info && (m->realpath[0] != '\0'))
      {
        mutt_str_copy(tmp, m->realpath, sizeof(tmp));
        mutt_pretty_mailbox(tmp, sizeof(tmp));
      }
      else
#endif
          if (m && (m->type == MUTT_NOTMUCH) && m->name)
      {
        mutt_str_copy(tmp, m->name, sizeof(tmp));
      }
      else if (m && !mutt_buffer_is_empty(&m->pathbuf))
      {
        mutt_str_copy(tmp, mailbox_path(m), sizeof(tmp));
        mutt_pretty_mailbox(tmp, sizeof(tmp));
      }
      else
        mutt_str_copy(tmp, _("(no mailbox)"), sizeof(tmp));

      snprintf(fmt, sizeof(fmt), "%%%ss", prec);
      snprintf(buf, buflen, fmt, tmp);
      break;
    case 'F':
    {
      const int num = m ? m->msg_flagged : 0;
      if (!optional)
      {
        snprintf(fmt, sizeof(fmt), "%%%sd", prec);
        snprintf(buf, buflen, fmt, num);
      }
      else if (num == 0)
        optional = false;
      break;
    }

    case 'h':
      snprintf(fmt, sizeof(fmt), "%%%ss", prec);
      snprintf(buf, buflen, fmt, NONULL(ShortHostname));
      break;

    case 'l':
    {
      const off_t num = m ? m->size : 0;
      if (!optional)
      {
        snprintf(fmt, sizeof(fmt), "%%%ss", prec);
        mutt_str_pretty_size(tmp, sizeof(tmp), num);
        snprintf(buf, buflen, fmt, tmp);
      }
      else if (num == 0)
        optional = false;
      break;
    }

    case 'L':
      if (!optional)
      {
        snprintf(fmt, sizeof(fmt), "%%%ss", prec);
        mutt_str_pretty_size(tmp, sizeof(tmp), ctx ? ctx->vsize : 0);
        snprintf(buf, buflen, fmt, tmp);
      }
      else if (!ctx_has_limit(ctx))
        optional = false;
      break;

    case 'm':
    {
      const int num = m ? m->msg_count : 0;
      if (!optional)
      {
        snprintf(fmt, sizeof(fmt), "%%%sd", prec);
        snprintf(buf, buflen, fmt, num);
      }
      else if (num == 0)
        optional = false;
      break;
    }

    case 'M':
      if (!optional)
      {
        snprintf(fmt, sizeof(fmt), "%%%sd", prec);
        snprintf(buf, buflen, fmt, m ? m->vcount : 0);
      }
      else if (!ctx_has_limit(ctx))
        optional = false;
      break;

    case 'n':
    {
      const int num = m ? m->msg_new : 0;
      if (!optional)
      {
        snprintf(fmt, sizeof(fmt), "%%%sd", prec);
        snprintf(buf, buflen, fmt, num);
      }
      else if (num == 0)
        optional = false;
      break;
    }

    case 'o':
    {
      const int num = m ? (m->msg_unread - m->msg_new) : 0;
      if (!optional)
      {
        snprintf(fmt, sizeof(fmt), "%%%sd", prec);
        snprintf(buf, buflen, fmt, num);
      }
      else if (num == 0)
        optional = false;
      break;
    }

    case 'p':
    {
      const int count = mutt_num_postponed(m, false);
      if (!optional)
      {
        snprintf(fmt, sizeof(fmt), "%%%sd", prec);
        snprintf(buf, buflen, fmt, count);
      }
      else if (count == 0)
        optional = false;
      break;
    }

    case 'P':
    {
      if (!menu)
        break;
      char *cp = NULL;
      if (menu->top + menu->pagelen >= menu->max)
      {
        cp = menu->top ?
                 /* L10N: Status bar message: the end of the list emails is visible in the index */
                 _("end") :
                 /* L10N: Status bar message: all the emails are visible in the index */
                 _("all");
      }
      else
      {
        int count = (100 * (menu->top + menu->pagelen)) / menu->max;
        snprintf(tmp, sizeof(tmp), "%d%%", count);
        cp = tmp;
      }
      snprintf(fmt, sizeof(fmt), "%%%ss", prec);
      snprintf(buf, buflen, fmt, cp);
      break;
    }

    case 'r':
    {
      size_t i = 0;

      if (m)
      {
        i = OptAttachMsg ? 3 :
                           ((m->readonly || m->dontwrite) ? 2 :
                            (m->changed ||
                             /* deleted doesn't necessarily mean changed in IMAP */
                             (m->type != MUTT_IMAP && m->msg_deleted)) ?
                                                            1 :
                                                            0);
      }

      const struct MbTable *c_status_chars =
          cs_subset_mbtable(NeoMutt->sub, "status_chars");
      if (!c_status_chars || !c_status_chars->len)
        buf[0] = '\0';
      else if (i >= c_status_chars->len)
        snprintf(buf, buflen, "%s", c_status_chars->chars[0]);
      else
        snprintf(buf, buflen, "%s", c_status_chars->chars[i]);
      break;
    }

    case 'R':
    {
      const int read = m ? (m->msg_count - m->msg_unread) : 0;
      if (!optional)
      {
        snprintf(fmt, sizeof(fmt), "%%%sd", prec);
        snprintf(buf, buflen, fmt, read);
      }
      else if (read == 0)
        optional = false;
      break;
    }

    case 's':
    {
      snprintf(fmt, sizeof(fmt), "%%%ss", prec);
      const short c_sort = cs_subset_sort(NeoMutt->sub, "sort");
      snprintf(buf, buflen, fmt, get_sort_str(tmp, sizeof(tmp), c_sort));
      break;
    }

    case 'S':
    {
      snprintf(fmt, sizeof(fmt), "%%%ss", prec);
      const short c_sort_aux = cs_subset_sort(NeoMutt->sub, "sort_aux");
      snprintf(buf, buflen, fmt, get_sort_str(tmp, sizeof(tmp), c_sort_aux));
      break;
    }

    case 't':
    {
      const int num = m ? m->msg_tagged : 0;
      if (!optional)
      {
        snprintf(fmt, sizeof(fmt), "%%%sd", prec);
        snprintf(buf, buflen, fmt, num);
      }
      else if (num == 0)
        optional = false;
      break;
    }

    case 'u':
      if (!optional)
      {
        snprintf(fmt, sizeof(fmt), "%%%sd", prec);
        snprintf(buf, buflen, fmt, m ? m->msg_unread : 0);
      }
      else if (!m || (m->msg_unread == 0))
        optional = false;
      break;

    case 'v':
      snprintf(buf, buflen, "%s", mutt_make_version());
      break;

    case 'V':
      if (!optional)
      {
        snprintf(fmt, sizeof(fmt), "%%%ss", prec);
        snprintf(buf, buflen, fmt, ctx_has_limit(ctx) ? ctx->pattern : "");
      }
      else if (!ctx_has_limit(ctx))
        optional = false;
      break;

    case 0:
      *buf = '\0';
      return src;

    default:
      snprintf(buf, buflen, "%%%s%c", prec, op);
      break;
  }

  if (optional)
  {
    mutt_expando_format(buf, buflen, col, cols, if_str, status_format_str, data,
                        MUTT_FORMAT_NO_FLAGS);
  }
  else if (flags & MUTT_FORMAT_OPTIONAL)
  {
    mutt_expando_format(buf, buflen, col, cols, else_str, status_format_str,
                        data, MUTT_FORMAT_NO_FLAGS);
  }

  /* We return the format string, unchanged */
  return src;
}

Here is the call graph for this function:

Here is the caller graph for this function:

menu_status_line()

void menu_status_line	(	char *	buf,
		size_t	buflen,
		struct IndexSharedData *	shared,
		struct Menu *	menu,
		int	cols,
		const char *	fmt
	)

Create the status line.

Parameters

[out]	buf	Buffer in which to save string
[in]	buflen	Buffer length
[in]	shared	Shared Index data
[in]	menu	Current menu
[in]	cols	Maximum number of columns to use
[in]	fmt	Format string

Definition at line 430 of file status.c.

{
  struct MenuStatusLineData data = { shared, menu };

  mutt_expando_format(buf, buflen, 0, cols, fmt, status_format_str,
                      (intptr_t) &data, MUTT_FORMAT_NO_FLAGS);
}

Here is the call graph for this function:

Here is the caller graph for this function: