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
|
/**
* \file
* \author Trevor Fountain
* \author Johannes Buchner
* \author Erik Garrison
* \date 2010-2014
* \copyright BSD 3-Clause
*
* progressbar -- a C class (by convention) for displaying progress
* on the command line (to stderr).
*/
#ifndef PROGRESSBAR_H
#define PROGRESSBAR_H
#include <time.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
/**
* Progressbar data structure (do not modify or create directly)
*/
typedef struct _progressbar_t
{
/// maximum value
unsigned long max;
/// current value
unsigned long value;
/// time progressbar was started
time_t start;
/// label
const char *label;
/// characters for the beginning, filling and end of the
/// progressbar. E.g. |### | has |#|
struct {
char begin;
char fill;
char end;
} format;
} progressbar;
/// Create a new progressbar with the specified label and number of steps.
///
/// @param label The label that will prefix the progressbar.
/// @param max The number of times the progressbar must be incremented before it is considered complete,
/// or, in other words, the number of tasks that this progressbar is tracking.
///
/// @return A progressbar configured with the provided arguments. Note that the user is responsible for disposing
/// of the progressbar via progressbar_finish when finished with the object.
progressbar *progressbar_new(const char *label, unsigned long max);
/// Create a new progressbar with the specified label, number of steps, and format string.
///
/// @param label The label that will prefix the progressbar.
/// @param max The number of times the progressbar must be incremented before it is considered complete,
/// or, in other words, the number of tasks that this progressbar is tracking.
/// @param format The format of the progressbar. The string provided must be three characters, and it will
/// be interpretted with the first character as the left border of the bar, the second
/// character of the bar and the third character as the right border of the bar. For example,
/// "<->" would result in a bar formatted like "<------ >".
///
/// @return A progressbar configured with the provided arguments. Note that the user is responsible for disposing
/// of the progressbar via progressbar_finish when finished with the object.
progressbar *progressbar_new_with_format(const char *label, unsigned long max, const char *format);
/// Free an existing progress bar. Don't call this directly; call *progressbar_finish* instead.
void progressbar_free(progressbar *bar);
/// Increment the given progressbar. Don't increment past the initialized # of steps, though.
void progressbar_inc(progressbar *bar);
/// Set the current status on the given progressbar.
void progressbar_update(progressbar *bar, unsigned long value);
/// Set the label of the progressbar. Note that no rendering is done. The label is simply set so that the next
/// rendering will use the new label. To immediately see the new label, call progressbar_draw.
/// Does not update display or copy the label
void progressbar_update_label(progressbar *bar, const char *label);
/// Finalize (and free!) a progressbar. Call this when you're done, or if you break out
/// partway through.
void progressbar_finish(progressbar *bar);
#endif
|
