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
|
#pragma once
#include <string>
#include <chrono>
#include <stack>
#include <map>
#include <vector>
#include <functional>
/// \ingroup core
///
/// Object keeping track of time spent in nested execution blocks,
/// and keeping track of out-of-band messages produced by these
/// blocks. The messaging facility is currently experimental.
class ProgressMonitor {
public:
ProgressMonitor(std::function<void(const std::string&, int, int)> report = nullptr, int report_level = 2);
virtual ~ProgressMonitor();
/// Start a new named group, or close the innermost one in case
/// the `name` argument is empty. All time spent inbetween calls
/// to group open/close calls is accumulated in a `Totals`
/// object, one for each group name. These `Totals` blocks can
/// be retrieved from the `totals` function.
/// FIXME: call this `block`.
void group(std::string name = "", int total = 0, int level = -1);
/// Set the progress of the current top-level block to be `n`
/// out of `total` steps. It is possible to change `totals` at
/// every call (e.g. in situations where the algorithm cannot
/// possibly figure out how many total steps there are to take.
void progress(); // Increment current step by 1
void progress(int n);
void progress(int n, int total);
/// Log out-of-band messages to the current block.
void message(const std::string&);
/// Generate debug output on `cerr`.
void print() const;
/// Callback for reporting a progress update
std::function<void(const std::string&, int, int)> report;
// Level above which to report progress updates and not only add to totals
int report_level;
/// Object to accumulate total time and call counts for a
/// particular named execution group.
class Total {
public:
Total();
std::string name;
size_t call_count;
std::chrono::milliseconds time_spent;
int total_steps;
std::vector<std::string> messages;
long time_spent_as_long() const;
bool operator==(const Total& other) const;
std::string str() const;
};
std::vector<Total> totals() const;
private:
/// A single element of the nested `group` call stack. Every
/// time a `group` function is called with a non-empty name,
/// a new `Block` is pushed onto the call stack. When `group`
/// is called with an empty name, the topmost `Block` is popped
/// from the stack, and its sub-totals added to the `Total`
/// element which thus collects data from multiple executions
/// of identically-named groups.
class Block {
public:
Block(const std::string& name, int level);
std::string name;
std::chrono::milliseconds started;
int step, total_steps;
std::vector<std::string> messages;
int level;
};
std::stack<Block> call_stack;
std::map<std::string, Total> call_totals;
};
class ScopedProgressGroup
{
public:
ScopedProgressGroup(ProgressMonitor* pm, const std::string& name, int total = 0, int level = -1);
~ScopedProgressGroup();
void progress();
void progress(int n);
void progress(int n, int total);
private:
ProgressMonitor* pm;
};
|
