progress.c

Go to the documentation of this file.

 
#include "config.h"
#include <stdarg.h>
#include <stdbool.h>
#include <stdio.h>
#include "mutt/lib.h"
#include "config/lib.h"
#include "core/lib.h"
#include "gui/lib.h"
#include "lib.h"
#include "globals.h"
#include "mutt_logging.h"
#include "window.h"
 
struct Progress;
 
static size_t choose_increment(enum ProgressType type)
{
  switch (type)
  {
    case MUTT_PROGRESS_NET:
      return cs_subset_number(NeoMutt->sub, "net_inc");
    case MUTT_PROGRESS_READ:
      return cs_subset_number(NeoMutt->sub, "read_inc");
    case MUTT_PROGRESS_WRITE:
      return cs_subset_number(NeoMutt->sub, "write_inc");
    default:
      return 0;
  }
}
 
bool progress_update(struct Progress *progress, size_t pos, int percent)
{
  if (!progress)
    return false;
 
  // Decloak an opaque pointer
  struct MuttWindow *win = (struct MuttWindow *) progress;
  const bool updated = progress_window_update(win, pos, percent);
 
  if (SigWinch)
  {
    SigWinch = false;
    notify_send(NeoMutt->notify_resize, NT_RESIZE, 0, NULL);
    window_redraw(NULL);
  }
  else
  {
    if (updated)
    {
      window_redraw(win);
    }
  }
 
  return updated;
}
 
void progress_free(struct Progress **ptr)
{
  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);
}
 
struct Progress *progress_new(enum ProgressType type, size_t size)
{
  if (OptNoCurses)
    return NULL;
 
  const size_t size_inc = choose_increment(type);
  if (size_inc == 0) // The user has disabled the progress bar
    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(size, size_inc, c_time_inc, is_bytes);
 
  msgcont_push_window(win);
 
  // Return an opaque pointer
  return (struct Progress *) win;
}
 
void progress_set_message(struct Progress *progress, const char *fmt, ...)
{
  // Decloak an opaque pointer
  struct MuttWindow *win = (struct MuttWindow *) progress;
 
  va_list ap;
  va_start(ap, fmt);
 
  if (win)
  {
    progress_window_set_message(win, fmt, ap);
  }
  else
  {
    char msg[1024] = { 0 };
    vsnprintf(msg, sizeof(msg), fmt, ap);
    mutt_message("%s", msg);
  }
 
  va_end(ap);
}
 
void progress_set_size(struct Progress *progress, size_t size)
{
  // Decloak an opaque pointer
  struct MuttWindow *win = (struct MuttWindow *) progress;
 
  progress_window_set_size(win, size);
}