progress.h File Reference

Progress bar. More...

#include <stdbool.h>
#include <stdint.h>
#include <stdio.h>

Include dependency graph for progress.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	Progress
	A progress bar. More...

Enumerations
enum	ProgressType { MUTT_PROGRESS_READ, MUTT_PROGRESS_WRITE, MUTT_PROGRESS_NET }
	What kind of operation is this progress tracking? More...

Functions
void	mutt_progress_init (struct Progress *progress, const char *msg, enum ProgressType type, size_t size)
	Set up a progress bar. More...
void	mutt_progress_update (struct Progress *progress, size_t pos, int percent)
	Update the state of the progress bar. More...

Variables
short	C_TimeInc
	Config: Frequency of progress bar updates (milliseconds) More...
short	C_ReadInc
	Config: Update the progress bar after this many records read (0 to disable) More...
short	C_WriteInc
	Config: Update the progress bar after this many records written (0 to disable) More...
short	C_NetInc
	Config: (socket) Update the progress bar after this many KB sent/received (0 to disable) More...

Detailed Description

Progress bar.

Authors

• Richard Russon
• Pietro Cerutti

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.h.

Enumeration Type Documentation

ProgressType

enum ProgressType

What kind of operation is this progress tracking?

Enumerator
MUTT_PROGRESS_READ	Progress tracks elements, according to $read_inc
MUTT_PROGRESS_WRITE	Progress tracks elements, according to $write_inc
MUTT_PROGRESS_NET	Progress tracks bytes, according to $net_inc

Definition at line 40 of file progress.h.

{
  MUTT_PROGRESS_READ,  
  MUTT_PROGRESS_WRITE, 
  MUTT_PROGRESS_NET    
};

Function Documentation

mutt_progress_init()

void mutt_progress_init	(	struct Progress *	progress,
		const char *	msg,
		enum ProgressType	type,
		size_t	size
	)

Set up a progress bar.

Parameters

progress	Progress bar
msg	Message to display; this is copied into the Progress object
type	Type, e.g. MUTT_PROGRESS_READ
size	Total size of expected file / traffic

Definition at line 153 of file progress.c.

{
  if (!progress || OptNoCurses)
    return;

  /* Initialize Progress structure */
  memset(progress, 0, sizeof(struct Progress));
  mutt_str_copy(progress->msg, msg, sizeof(progress->msg));
  progress->size = size;
  progress->inc = progress_choose_increment(type);
  progress->is_bytes = (type == MUTT_PROGRESS_NET);

  /* Generate the size string, if a total size was specified */
  if (progress->size != 0)
  {
    if (progress->is_bytes)
    {
      mutt_str_pretty_size(progress->sizestr, sizeof(progress->sizestr),
                           progress->size);
    }
    else
    {
      snprintf(progress->sizestr, sizeof(progress->sizestr), "%zu", progress->size);
    }
  }

  if (progress->inc == 0)
  {
    /* This progress bar does not increment - write the initial message */
    if (progress->size == 0)
    {
      mutt_message(progress->msg);
    }
    else
    {
      mutt_message("%s (%s)", progress->msg, progress->sizestr);
    }
  }
  else
  {
    /* This progress bar does increment - perform the initial update */
    mutt_progress_update(progress, 0, 0);
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_progress_update()

void mutt_progress_update	(	struct Progress *	progress,
		size_t	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 212 of file progress.c.

{
  if (OptNoCurses)
    return;

  const uint64_t now = mutt_date_epoch_ms();

  const bool update = (pos == 0) /* always show the first update */ ||
                      (progress_pos_needs_update(progress, pos) &&
                       progress_time_needs_update(progress, now));

  if (progress->inc != 0 && update)
  {
    progress->pos = pos;
    progress->timestamp = now;

    char posstr[128];
    if (progress->is_bytes)
    {
      const size_t round_pos =
          (progress->pos / (progress->inc << 10)) * (progress->inc << 10);
      mutt_str_pretty_size(posstr, sizeof(posstr), round_pos);
    }
    else
    {
      snprintf(posstr, sizeof(posstr), "%zu", progress->pos);
    }

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

    if (progress->size != 0)
    {
      if (percent < 0)
      {
        percent = 100.0 * progress->pos / progress->size;
      }
      message_bar(percent, "%s %s/%s (%d%%)", progress->msg, posstr,
                  progress->sizestr, percent);
    }
    else
    {
      if (percent > 0)
        message_bar(percent, "%s %s (%d%%)", progress->msg, posstr, percent);
      else
        mutt_message("%s %s", progress->msg, posstr);
    }
  }

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

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

C_TimeInc

short C_TimeInc

Config: Frequency of progress bar updates (milliseconds)

Definition at line 43 of file progress.c.

C_ReadInc

short C_ReadInc

Config: Update the progress bar after this many records read (0 to disable)

Definition at line 44 of file progress.c.

C_WriteInc

short C_WriteInc

Config: Update the progress bar after this many records written (0 to disable)

Definition at line 45 of file progress.c.

C_NetInc

short C_NetInc

Config: (socket) Update the progress bar after this many KB sent/received (0 to disable)

Definition at line 46 of file progress.c.