window.c File Reference

Progress Bar Window. More...

#include "config.h"
#include <stdarg.h>
#include <stdbool.h>
#include <stdint.h>
#include <stdio.h>
#include "mutt/lib.h"
#include "gui/lib.h"
#include "color/lib.h"
#include "muttlib.h"
#include "wdata.h"

Include dependency graph for window.c:

Go to the source code of this file.

Functions
static void	message_bar (struct MuttWindow *win, int percent, const char *fmt,...)
	Draw a colourful progress bar.
static int	progress_window_recalc (struct MuttWindow *win)
	Recalculate the Progress Bar - Implements MuttWindow::recalc() -.
static int	progress_window_repaint (struct MuttWindow *win)
	Repaint the Progress Bar - Implements MuttWindow::repaint() -.
static bool	percent_needs_update (const struct ProgressWindowData *wdata, int percent)
	Do we need to update, given the current percentage?
static bool	pos_needs_update (const struct ProgressWindowData *wdata, long pos)
	Do we need to update, given the current pos?
static bool	time_needs_update (const struct ProgressWindowData *wdata, size_t now)
	Do we need to update, given the current time?
bool	progress_window_update (struct MuttWindow *win, size_t pos, int percent)
	Update the Progress Bar Window.
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.

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

Function Documentation

message_bar()

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

static

Draw a colourful progress bar.

Parameters

win	Window to draw on
percent	age complete
fmt	printf(1)-like formatting string
...	Arguments to formatting string

Definition at line 74 of file window.c.

{
  if (!fmt || !win || !win->wdata)
    return;
 
  va_list ap;
  char buf[256], buf2[256];
  int w = (percent * win->state.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, win->state.cols - 2, JUSTIFY_LEFT,
                     0, buf, sizeof(buf), false);
 
  mutt_window_move(win, 0, 0);
 
  if ((percent != -1) && simple_color_is_set(MT_COLOR_PROGRESS))
  {
    if (l < w)
    {
      /* The string fits within the colour bar */
      mutt_curses_set_normal_backed_color_by_id(MT_COLOR_PROGRESS);
      mutt_window_addstr(win, buf2);
      w -= l;
      while (w-- > 0)
      {
        mutt_window_addch(win, ' ');
      }
      mutt_curses_set_color_by_id(MT_COLOR_NORMAL);
    }
    else
    {
      /* The string is too long for the colour bar */
      int off = mutt_wstr_trunc(buf2, sizeof(buf2), w, NULL);
 
      char ch = buf2[off];
      buf2[off] = '\0';
      mutt_curses_set_normal_backed_color_by_id(MT_COLOR_PROGRESS);
      mutt_window_addstr(win, buf2);
      buf2[off] = ch;
      mutt_curses_set_color_by_id(MT_COLOR_NORMAL);
      mutt_window_addstr(win, &buf2[off]);
    }
  }
  else
  {
    mutt_window_addstr(win, buf2);
  }
 
  mutt_window_clrtoeol(win);
}

Here is the call graph for this function:

Here is the caller graph for this function:

percent_needs_update()

static bool percent_needs_update ( const struct ProgressWindowData *  wdata, int  percent  )

static

Do we need to update, given the current percentage?

Parameters

wdata	Private data
percent	Updated percentage

Return values

true	Progress needs an update

Definition at line 230 of file window.c.

{
  return (percent > wdata->display_percent);
}

Here is the caller graph for this function:

pos_needs_update()

static bool pos_needs_update ( const struct ProgressWindowData *  wdata, long  pos  )

static

Do we need to update, given the current pos?

Parameters

wdata	Private data
pos	Current pos

Return values

true	Progress needs an update

Definition at line 241 of file window.c.

{
  const unsigned shift = wdata->is_bytes ? 10 : 0;
  return pos >= (wdata->display_pos + (wdata->size_inc << shift));
}

Here is the caller graph for this function:

time_needs_update()

static bool time_needs_update ( const struct ProgressWindowData *  wdata, size_t  now  )

static

Do we need to update, given the current time?

Parameters

wdata	Private data
now	Time

Return values

true	Progress needs an update

Definition at line 253 of file window.c.

{
  if (wdata->time_inc == 0)
    return true;
 
  if (now < wdata->display_time)
    return true;
 
  const size_t elapsed = (now - wdata->display_time);
  return (wdata->time_inc < elapsed);
}

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

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 309 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 344 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 361 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: