progress.c File Reference

Progress bar. More...

#include "config.h"
#include <errno.h>
#include <stdarg.h>
#include <stdbool.h>
#include <string.h>
#include <sys/time.h>
#include "mutt/mutt.h"
#include "progress.h"
#include "curs_lib.h"
#include "mutt_curses.h"
#include "mutt_logging.h"
#include "options.h"

Include dependency graph for progress.c:

Go to the source code of this file.

Functions
static void	message_bar (int percent, const char *fmt,...)
	Draw a colourful progress bar. More...
void	mutt_progress_init (struct Progress *progress, const char *msg, unsigned short flags, unsigned short inc, size_t size)
	Set up a progress bar. More...
void	mutt_progress_update (struct Progress *progress, long pos, int percent)
	Update the state of the progress bar. More...

Variables
short	TimeInc
	Config: Frequency of progress bar updates (milliseconds) More...

Detailed Description

Progress bar.

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

Function Documentation

static void message_bar ( int  percent, const char *  fmt,   ...  )

static

Draw a colourful progress bar.

Parameters

percent	age complete
fmt	printf(1)-like formatting string
...	Arguments to formatting string

Definition at line 51 of file progress.c.

{
  va_list ap;
  char buf[STRING], buf2[STRING];
  int w = percent * COLS / 100;
  size_t l;

  va_start(ap, fmt);
  vsnprintf(buf, sizeof(buf), fmt, ap);
  l = mutt_strwidth(buf);
  va_end(ap);

  mutt_simple_format(buf2, sizeof(buf2), 0, COLS - 2, FMT_LEFT, 0, buf, sizeof(buf), 0);

  move(LINES - 1, 0);

  if (ColorDefs[MT_COLOR_PROGRESS] == 0)
  {
    addstr(buf2);
  }
  else
  {
    if (l < w)
    {
      /* The string fits within the colour bar */
      SETCOLOR(MT_COLOR_PROGRESS);
      addstr(buf2);
      w -= l;
      while (w-- > 0)
      {
        addch(' ');
      }
      NORMAL_COLOR;
    }
    else
    {
      /* The string is too long for the colour bar */
      char ch;
      int off = mutt_wstr_trunc(buf2, sizeof(buf2), w, NULL);

      ch = buf2[off];
      buf2[off] = '\0';
      SETCOLOR(MT_COLOR_PROGRESS);
      addstr(buf2);
      buf2[off] = ch;
      NORMAL_COLOR;
      addstr(&buf2[off]);
    }
  }

  clrtoeol();
  mutt_refresh();
}

Here is the call graph for this function:

Here is the caller graph for this function:

void mutt_progress_init	(	struct Progress *	progress,
		const char *	msg,
		unsigned short	flags,
		unsigned short	inc,
		size_t	size
	)

Set up a progress bar.

Parameters

progress	Progress bar
msg	Message to display
flags	Flags, e.g. MUTT_PROGRESS_SIZE
inc	Increments to display (0 disables updates)
size	Total size of expected file / traffic

Definition at line 113 of file progress.c.

{
  struct timeval tv = { 0, 0 };

  if (!progress)
    return;
  if (OptNoCurses)
    return;

  memset(progress, 0, sizeof(struct Progress));
  progress->inc = inc;
  progress->flags = flags;
  progress->msg = msg;
  progress->size = size;
  if (progress->size != 0)
  {
    if (progress->flags & MUTT_PROGRESS_SIZE)
    {
      mutt_str_pretty_size(progress->sizestr, sizeof(progress->sizestr),
                           progress->size);
    }
    else
      snprintf(progress->sizestr, sizeof(progress->sizestr), "%zu", progress->size);
  }
  if (inc == 0)
  {
    if (size != 0)
      mutt_message("%s (%s)", msg, progress->sizestr);
    else
      mutt_message(msg);
    return;
  }
  if (gettimeofday(&tv, NULL) < 0)
    mutt_debug(1, "gettimeofday failed: %d\n", errno);
  /* if timestamp is 0 no time-based suppression is done */
  if (TimeInc != 0)
  {
    progress->timestamp =
        ((unsigned int) tv.tv_sec * 1000) + (unsigned int) (tv.tv_usec / 1000);
  }
  mutt_progress_update(progress, 0, 0);
}

Here is the call graph for this function:

Here is the caller graph for this function:

void mutt_progress_update	(	struct Progress *	progress,
		long	pos,
		int	percent
	)

Update the state of the progress bar.

Parameters

progress	Progress bar
pos	Position, or count
percent	Percentage complete

If percent is -1, then the percentage will be calculated using pos and the size in progress.

If percent is positive, it is displayed as percentage, otherwise percentage is calculated from progress->size and pos if progress was initialized with positive size, otherwise no percentage is shown

Definition at line 170 of file progress.c.

{
  char posstr[SHORT_STRING];
  bool update = false;
  struct timeval tv = { 0, 0 };
  unsigned int now = 0;

  if (OptNoCurses)
    return;

  if (progress->inc == 0)
    goto out;

  /* refresh if size > inc */
  if ((progress->flags & MUTT_PROGRESS_SIZE) &&
      (pos >= (progress->pos + (progress->inc << 10))))
  {
    update = true;
  }
  else if (pos >= (progress->pos + progress->inc))
    update = true;

  /* skip refresh if not enough time has passed */
  if (update && progress->timestamp && (gettimeofday(&tv, NULL) == 0))
  {
    now = ((unsigned int) tv.tv_sec * 1000) + (unsigned int) (tv.tv_usec / 1000);
    if (now && ((now - progress->timestamp) < TimeInc))
      update = false;
  }

  /* always show the first update */
  if (pos == 0)
    update = true;

  if (update)
  {
    if (progress->flags & MUTT_PROGRESS_SIZE)
    {
      pos = pos / (progress->inc << 10) * (progress->inc << 10);
      mutt_str_pretty_size(posstr, sizeof(posstr), pos);
    }
    else
      snprintf(posstr, sizeof(posstr), "%ld", pos);

    mutt_debug(5, "updating progress: %s\n", posstr);

    progress->pos = pos;
    if (now)
      progress->timestamp = now;

    if (progress->size > 0)
    {
      message_bar(
          (percent > 0) ? percent :
                          (int) (100.0 * (double) progress->pos / progress->size),
          "%s %s/%s (%d%%)", progress->msg, posstr, progress->sizestr,
          (percent > 0) ? percent :
                          (int) (100.0 * (double) progress->pos / progress->size));
    }
    else
    {
      if (percent > 0)
        message_bar(percent, "%s %s (%d%%)", progress->msg, posstr, percent);
      else
        mutt_message("%s %s", progress->msg, posstr);
    }
  }

out:
  if (pos >= progress->size)
    mutt_clear_error();
}

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

short TimeInc

Config: Frequency of progress bar updates (milliseconds)

Definition at line 43 of file progress.c.