lib.h File Reference

Progress bar. More...

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

Include dependency graph for lib.h:

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

Go to the source code of this file.

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

Functions
void	progress_free (struct Progress **ptr)
	Free a Progress Bar. More...
struct Progress *	progress_new (const char *msg, enum ProgressType type, size_t size)
	Create a new Progress Bar. More...
bool	progress_update (struct Progress *progress, size_t pos, int percent)
	Update the state of the progress bar. 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 lib.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 47 of file lib.h.

{
  MUTT_PROGRESS_READ,  
  MUTT_PROGRESS_WRITE, 
  MUTT_PROGRESS_NET    
};

Function Documentation

progress_free()

void progress_free

(

struct Progress **

ptr

)

Free a Progress Bar.

Parameters

ptr	Progress Bar to free

Definition at line 86 of file progress.c.

{
  if (!ptr)
    return;
 
  if (!*ptr)
  {
    mutt_clear_error();
    return;
  }
 
  // Decloak an opaque pointer
  struct MuttWindow **wptr = (struct MuttWindow **) ptr;
  struct MuttWindow *win_pop = msgcont_pop_window();
  if (win_pop != *wptr)
    return;
 
  mutt_window_free(wptr);
}

Here is the call graph for this function:

Here is the caller graph for this function:

progress_new()

struct Progress * progress_new	(	const char *	msg,
		enum ProgressType	type,
		size_t	size
	)

Create a new Progress Bar.

Parameters

msg	Message to display
type	Type, e.g. MUTT_PROGRESS_READ
size	Total size of expected file / traffic

Return values

ptr	New Progress Bar

If the user has disabled the progress bar, e.g. set read_inc = 0 then a simple message will be displayed instead.

Note

msg will be copied

Definition at line 118 of file progress.c.

{
  if (OptNoCurses)
    return NULL;
 
  const size_t size_inc = choose_increment(type);
  if (size_inc == 0) // The user has disabled the progress bar
  {
    mutt_message(msg);
    return NULL;
  }
 
  const short c_time_inc = cs_subset_number(NeoMutt->sub, "time_inc");
  const bool is_bytes = (type == MUTT_PROGRESS_NET);
 
  struct MuttWindow *win = progress_window_new(msg, size, size_inc, c_time_inc, is_bytes);
 
  msgcont_push_window(win);
 
  // Return an opaque pointer
  return (struct Progress *) win;
}

Here is the call graph for this function:

Here is the caller graph for this function:

progress_update()

bool 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

Return values

true	Screen update is needed

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 size and pos if progress was initialized with positive size, otherwise no percentage is shown

Definition at line 73 of file progress.c.

{
  // Decloak an opaque pointer
  struct MuttWindow *win = (struct MuttWindow *) progress;
  const bool updated = progress_window_update(win, pos, percent);
  window_redraw(win);
  return updated;
}

Here is the call graph for this function:

Here is the caller graph for this function: