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
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
|
/* $Id: ProgressImpl.h $ */
/** @file
*
* VirtualBox COM class implementation
*/
/*
* Copyright (C) 2006-2023 Oracle and/or its affiliates.
*
* This file is part of VirtualBox base platform packages, as
* available from https://www.virtualbox.org.
*
* 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, in version 3 of the
* License.
*
* 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 <https://www.gnu.org/licenses>.
*
* SPDX-License-Identifier: GPL-3.0-only
*/
#ifndef MAIN_INCLUDED_ProgressImpl_h
#define MAIN_INCLUDED_ProgressImpl_h
#ifndef RT_WITHOUT_PRAGMA_ONCE
# pragma once
#endif
#include "ProgressWrap.h"
#include "VirtualBoxBase.h"
#include "EventImpl.h"
#include <iprt/semaphore.h>
////////////////////////////////////////////////////////////////////////////////
/**
* Class for progress objects.
*/
class ATL_NO_VTABLE Progress :
public ProgressWrap
{
public:
DECLARE_NOT_AGGREGATABLE(Progress)
HRESULT FinalConstruct();
void FinalRelease();
// public initializer/uninitializer for internal purposes only
/**
* Simplified constructor for progress objects that have only one
* operation as a task.
* @param aParent
* @param aInitiator
* @param aDescription
* @param aCancelable
* @return
*/
HRESULT init(
#if !defined(VBOX_COM_INPROC)
VirtualBox *aParent,
#endif
IUnknown *aInitiator,
const Utf8Str &aDescription,
BOOL aCancelable)
{
return init(
#if !defined(VBOX_COM_INPROC)
aParent,
#endif
aInitiator,
aDescription,
aCancelable,
1, // cOperations
1, // ulTotalOperationsWeight
aDescription, // aFirstOperationDescription
1); // ulFirstOperationWeight
}
/**
* Not quite so simplified constructor for progress objects that have
* more than one operation, but all sub-operations are weighed the same.
* @param aParent
* @param aInitiator
* @param aDescription
* @param aCancelable
* @param cOperations
* @param aFirstOperationDescription
* @return
*/
HRESULT init(
#if !defined(VBOX_COM_INPROC)
VirtualBox *aParent,
#endif
IUnknown *aInitiator,
const Utf8Str &aDescription, BOOL aCancelable,
ULONG cOperations,
const Utf8Str &aFirstOperationDescription)
{
return init(
#if !defined(VBOX_COM_INPROC)
aParent,
#endif
aInitiator,
aDescription,
aCancelable,
cOperations, // cOperations
cOperations, // ulTotalOperationsWeight = cOperations
aFirstOperationDescription, // aFirstOperationDescription
1); // ulFirstOperationWeight: weigh them all the same
}
HRESULT init(
#if !defined(VBOX_COM_INPROC)
VirtualBox *aParent,
#endif
IUnknown *aInitiator,
const Utf8Str &aDescription,
BOOL aCancelable,
ULONG cOperations,
ULONG ulTotalOperationsWeight,
const Utf8Str &aFirstOperationDescription,
ULONG ulFirstOperationWeight);
HRESULT init(BOOL aCancelable,
ULONG aOperationCount,
const Utf8Str &aOperationDescription);
void uninit();
// public methods only for internal purposes
HRESULT i_notifyComplete(HRESULT aResultCode);
HRESULT i_notifyComplete(HRESULT aResultCode,
const GUID &aIID,
const char *pcszComponent,
const char *aText,
...);
HRESULT i_notifyCompleteV(HRESULT aResultCode,
const GUID &aIID,
const char *pcszComponent,
const char *aText,
va_list va);
HRESULT i_notifyCompleteBoth(HRESULT aResultCode,
int vrc,
const GUID &aIID,
const char *pcszComponent,
const char *aText,
...);
HRESULT i_notifyCompleteBothV(HRESULT aResultCode,
int vrc,
const GUID &aIID,
const char *pcszComponent,
const char *aText,
va_list va);
bool i_setCancelCallback(void (*pfnCallback)(void *), void *pvUser);
static DECLCALLBACK(int) i_iprtProgressCallback(unsigned uPercentage, void *pvUser);
static DECLCALLBACK(int) i_vdProgressCallback(void *pvUser, unsigned uPercentage);
protected:
DECLARE_COMMON_CLASS_METHODS(Progress)
#if !defined(VBOX_COM_INPROC)
/** Weak parent. */
VirtualBox * const mParent;
#endif
const ComObjPtr<EventSource> pEventSource;
const ComPtr<IUnknown> mInitiator;
const Guid mId;
const com::Utf8Str mDescription;
uint64_t m_ullTimestamp; // progress object creation timestamp, for ETA computation
void (*m_pfnCancelCallback)(void *);
void *m_pvCancelUserArg;
/* The fields below are to be properly initialized by subclasses */
BOOL mCompleted;
BOOL mCancelable;
BOOL mCanceled;
HRESULT mResultCode;
ComPtr<IVirtualBoxErrorInfo> mErrorInfo;
ULONG m_cOperations; // number of operations (so that progress dialog can
// display something like 1/3)
ULONG m_ulTotalOperationsWeight; // sum of weights of all operations, given to constructor
ULONG m_ulOperationsCompletedWeight; // summed-up weight of operations that have been completed; initially 0
ULONG m_ulCurrentOperation; // operations counter, incremented with
// each setNextOperation()
com::Utf8Str m_operationDescription; // name of current operation; initially
// from constructor, changed with setNextOperation()
ULONG m_ulCurrentOperationWeight; // weight of current operation, given to setNextOperation()
ULONG m_ulOperationPercent; // percentage of current operation, set with setCurrentOperationProgress()
ULONG m_cMsTimeout; /**< Automatic timeout value. 0 means none. */
private:
// wrapped IProgress properties
HRESULT getId(com::Guid &aId);
HRESULT getDescription(com::Utf8Str &aDescription);
HRESULT getInitiator(ComPtr<IUnknown> &aInitiator);
HRESULT getCancelable(BOOL *aCancelable);
HRESULT getPercent(ULONG *aPercent);
HRESULT getTimeRemaining(LONG *aTimeRemaining);
HRESULT getCompleted(BOOL *aCompleted);
HRESULT getCanceled(BOOL *aCanceled);
HRESULT getResultCode(LONG *aResultCode);
HRESULT getErrorInfo(ComPtr<IVirtualBoxErrorInfo> &aErrorInfo);
HRESULT getOperationCount(ULONG *aOperationCount);
HRESULT getOperation(ULONG *aOperation);
HRESULT getOperationDescription(com::Utf8Str &aOperationDescription);
HRESULT getOperationPercent(ULONG *aOperationPercent);
HRESULT getOperationWeight(ULONG *aOperationWeight);
HRESULT getTimeout(ULONG *aTimeout);
HRESULT setTimeout(ULONG aTimeout);
HRESULT getEventSource(ComPtr<IEventSource> &aEventSource);
// wrapped IProgress methods
HRESULT waitForCompletion(LONG aTimeout);
HRESULT waitForOperationCompletion(ULONG aOperation,
LONG aTimeout);
HRESULT cancel();
// wrapped IInternalProgressControl methods
HRESULT setCurrentOperationProgress(ULONG aPercent);
HRESULT waitForOtherProgressCompletion(const ComPtr<IProgress> &aProgressOther,
ULONG aTimeoutMS);
HRESULT setNextOperation(const com::Utf8Str &aNextOperationDescription,
ULONG aNextOperationsWeight);
HRESULT notifyPointOfNoReturn();
HRESULT notifyComplete(LONG aResultCode,
const ComPtr<IVirtualBoxErrorInfo> &aErrorInfo);
// internal helper methods
HRESULT i_notifyCompleteWorker(HRESULT aResultCode, const ComPtr<IVirtualBoxErrorInfo> &aErrorInfo);
double i_calcTotalPercent();
void i_checkForAutomaticTimeout(void);
RTSEMEVENTMULTI mCompletedSem;
ULONG mWaitersCount;
private:
DECLARE_CLS_COPY_CTOR_ASSIGN_NOOP(Progress); /* Shuts up MSC warning C4625. */
};
#endif /* !MAIN_INCLUDED_ProgressImpl_h */
|
