window.h File Reference

Progress Bar Window. More...

#include <stddef.h>
#include <stdarg.h>
#include <stdbool.h>

Include dependency graph for window.h:

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

Go to the source code of this file.

Functions
struct MuttWindow *	progress_window_new (size_t size, size_t size_inc, size_t time_inc, bool is_bytes)
	Create a new Progress Bar Window.
void	progress_window_set_message (struct MuttWindow *win, const char *fmt, va_list ap)
	Set the progress message.
void	progress_window_set_size (struct MuttWindow *win, size_t size)
	Set the progress size.
bool	progress_window_update (struct MuttWindow *win, size_t pos, int percent)
	Update the Progress Bar Window.

Detailed Description

Progress Bar Window.

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

Function Documentation

progress_window_new()

struct MuttWindow * progress_window_new	(	size_t	size,
		size_t	size_inc,
		size_t	time_inc,
		bool	is_bytes
	)

Create a new Progress Bar Window.

Parameters

size	Expected number of records or size of traffic
size_inc	Size increment (step size)
time_inc	Time increment
is_bytes	true if measuring bytes

Return values

ptr	New Progress Window

Definition at line 311 of file window.c.

{
  if (size_inc == 0) // The user has disabled the progress bar
    return NULL;
 
  struct MuttWindow *win = mutt_window_new(WT_STATUS_BAR, MUTT_WIN_ORIENT_VERTICAL,
                                           MUTT_WIN_SIZE_FIXED,
                                           MUTT_WIN_SIZE_UNLIMITED, 1);
  win->recalc = progress_window_recalc;
  win->repaint = progress_window_repaint;
  win->actions |= WA_RECALC;
 
  struct ProgressWindowData *wdata = progress_wdata_new();
  wdata->win = win;
  wdata->size = size;
  wdata->size_inc = size_inc;
  wdata->time_inc = time_inc;
  wdata->is_bytes = is_bytes;
 
  if (is_bytes)
    mutt_str_pretty_size(wdata->pretty_size, sizeof(wdata->pretty_size), size);
 
  win->wdata = wdata;
  win->wdata_free = progress_wdata_free;
 
  return win;
}

Here is the call graph for this function:

Here is the caller graph for this function:

progress_window_set_message()

void progress_window_set_message	(	struct MuttWindow *	win,
		const char *	fmt,
		va_list	ap
	)

Set the progress message.

Parameters

win	Window to draw on
fmt	printf format string
ap	printf arguments

Definition at line 346 of file window.c.

{
  if (!win || !win->wdata || !fmt)
    return;
 
  struct ProgressWindowData *wdata = win->wdata;
 
  vsnprintf(wdata->msg, sizeof(wdata->msg), fmt, ap);
 
  win->actions |= WA_RECALC;
}

Here is the caller graph for this function:

progress_window_set_size()

void progress_window_set_size	(	struct MuttWindow *	win,
		size_t	size
	)

Set the progress size.

Parameters

win	Window to draw on
size	New size

Definition at line 363 of file window.c.

{
  if (!win || !win->wdata)
    return;
 
  struct ProgressWindowData *wdata = win->wdata;
 
  wdata->size = size;
  wdata->display_pos = 0;
  wdata->display_percent = 0;
  wdata->display_time = 0;
  win->actions |= WA_RECALC;
}

Here is the caller graph for this function:

progress_window_update()

bool progress_window_update	(	struct MuttWindow *	win,
		size_t	pos,
		int	percent
	)

Update the Progress Bar Window.

Parameters

win	Window to draw on
pos	Position, or count
percent	Percentage complete

Return values

true	Screen update is needed

Definition at line 274 of file window.c.

{
  if (!win || !win->wdata)
    return false;
 
  struct ProgressWindowData *wdata = win->wdata;
 
  if (percent >= 0)
  {
    if (!percent_needs_update(wdata, percent))
      return false;
  }
  else
  {
    if (!pos_needs_update(wdata, pos))
      return false;
  }
 
  const uint64_t now = mutt_date_now_ms();
  if (!time_needs_update(wdata, now))
    return false;
 
  wdata->update_pos = pos;
  wdata->update_percent = percent;
  wdata->update_time = now;
  win->actions |= WA_RECALC;
  return true;
}

Here is the call graph for this function:

Here is the caller graph for this function: