aboutsummaryrefslogtreecommitdiff
path: root/src/zen/progressbar.h
blob: 94df2ca3ae2ce90b55e39d72211ee7583edbba82 (plain) (blame)
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
// Copyright Epic Games, Inc. All Rights Reserved.

#pragma once

#include <zencore/timer.h>
#include <zencore/zencore.h>

#include <string>

namespace zen {

class OperationLogOutput;

class ProgressBar
{
public:
	struct State
	{
		bool		operator==(const State&) const = default;
		std::string Task;
		std::string Details;
		uint64_t	TotalCount			= 0;
		uint64_t	RemainingCount		= 0;
		uint64_t	OptionalElapsedTime = (uint64_t)-1;
		enum class EStatus
		{
			Running,
			Aborted,
			Paused
		};
		EStatus Status = EStatus::Running;

		static EStatus CalculateStatus(bool IsAborted, bool IsPaused)
		{
			if (IsAborted)
			{
				return EStatus::Aborted;
			}
			if (IsPaused)
			{
				return EStatus::Paused;
			}
			return EStatus::Running;
		}
	};

	enum class Mode
	{
		Plain,
		Pretty,
		PrettyScroll,
		Log,
		Quiet
	};

	static void SetLogOperationName(Mode InMode, std::string_view Name);
	static void SetLogOperationProgress(Mode InMode, uint32_t StepIndex, uint32_t StepCount);
	static void PushLogOperation(Mode InMode, std::string_view Name);
	static void PopLogOperation(Mode InMode);

	explicit ProgressBar(Mode InMode, std::string_view InSubTask);
	~ProgressBar();

	void UpdateState(const State& NewState, bool DoLinebreak);
	void ForceLinebreak();
	void Finish();
	bool IsSameTask(std::string_view Task) const;
	bool HasActiveTask() const;

private:
	void SetupScrollRegion();
	void TeardownScrollRegion();
	void RenderStatusLine(std::string_view Line);

	const Mode		  m_Mode;
	Stopwatch		  m_SW;
	uint64_t		  m_LastUpdateMS;
	uint64_t		  m_PausedMS;
	State			  m_State;
	const std::string m_SubTask;
	size_t			  m_LastOutputLength   = 0;
	bool			  m_ScrollRegionActive = false;
	uint32_t		  m_ScrollRegionRows   = 0;
};

uint32_t GetUpdateDelayMS(ProgressBar::Mode InMode);

OperationLogOutput* CreateConsoleLogOutput(ProgressBar::Mode InMode);

}  // namespace zen