1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
|
/**
* @file
* Progress bar
*
* @authors
* Copyright (C) 2019 Pietro Cerutti <gahr@gahr.ch>
* Copyright (C) 2021-2023 Richard Russon <rich@flatcap.org>
*
* @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/>.
*/
/**
* @page progress_progress Progress Bar
*
* This is a wrapper around the Progress Bar Window.
* After creating the window, it pushes it into the Message Window Container.
*/
#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;
/**
* choose_increment - Choose the right increment given a ProgressType
* @param type ProgressType
* @retval num Increment value
*/
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;
}
}
/**
* progress_update - Update the state of the progress bar
* @param progress Progress bar
* @param pos Position, or count
* @param percent Percentage complete
* @retval 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
*/
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;
}
/**
* progress_free - Free a Progress Bar
* @param ptr Progress Bar to free
*/
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);
}
/**
* progress_new - Create a new Progress Bar
* @param type Type, e.g. #MUTT_PROGRESS_READ
* @param size Total size of expected file / traffic
* @retval 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.
*/
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;
}
/**
* progress_set_message - Set the progress message
* @param progress Progress bar
* @param fmt Format string
* @param ... Format parameters
*/
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);
}
/**
* progress_set_size - Set the progress size
*/
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);
}
|
