Changeset 25859 in vbox for trunk/src/VBox/Main/include/ProgressCombinedImpl.h

Timestamp:

Jan 15, 2010 1:27:16 PM (15 years ago)

Author:

vboxsync

svn:sync-xref-src-repo-rev:

56658

Message:

Main: cleanup: get rid of VirtualBoxBaseProto, move AutoCaller*/*Span* classes out of VirtualBoxBaseProto class scope and into separate header; move CombinedProgress into separate header (it's only used by Console any more)

File:

• trunk/src/VBox/Main/include/ProgressCombinedImpl.h (copied) (copied from trunk/src/VBox/Main/include/ProgressImpl.h ) (3 diffs)

trunk/src/VBox/Main/include/ProgressCombinedImpl.h

@@ -6 +6 @@
 
 /*
- * Copyright (C) 2006-2009 Sun Microsystems, Inc.
+ * Copyright (C) 2006-2010 Sun Microsystems, Inc.
  *
  * This file is part of VirtualBox Open Source Edition (OSE), as
@@ -21 +21 @@
  */
 
-#ifndef ____H_PROGRESSIMPL
-#define ____H_PROGRESSIMPL
+#ifndef ____H_PROGRESSCOMBINEDIMPL
+#define ____H_PROGRESSCOMBINEDIMPL
 
-#include "VirtualBoxBase.h"
-
-#include <VBox/com/SupportErrorInfo.h>
-
-#include <iprt/semaphore.h>
+#include "ProgressImpl.h"
+#include "AutoCaller.h"
 
 #include <vector>
-
-class VirtualBox;
-
-////////////////////////////////////////////////////////////////////////////////
-
-/**
- * Base component class for progress objects.
- */
-class ATL_NO_VTABLE ProgressBase :
-    public VirtualBoxBase,
-    public com::SupportErrorInfoBase,
-    public VirtualBoxSupportTranslation<ProgressBase>,
-    VBOX_SCRIPTABLE_IMPL(IProgress)
-{
-protected:
-
-    VIRTUALBOXBASE_ADD_ERRORINFO_SUPPORT (ProgressBase)
-
-    DECLARE_EMPTY_CTOR_DTOR (ProgressBase)
-
-    HRESULT FinalConstruct();
-
-    // protected initializer/uninitializer for internal purposes only
-    HRESULT protectedInit (AutoInitSpan &aAutoInitSpan,
-#if !defined (VBOX_COM_INPROC)
-                  VirtualBox *aParent,
-#endif
-                  IUnknown *aInitiator,
-                  CBSTR aDescription, OUT_GUID aId = NULL);
-    HRESULT protectedInit (AutoInitSpan &aAutoInitSpan);
-    void protectedUninit (AutoUninitSpan &aAutoUninitSpan);
-
-public:
-
-    // IProgress properties
-    STDMETHOD(COMGETTER(Id)) (BSTR *aId);
-    STDMETHOD(COMGETTER(Description)) (BSTR *aDescription);
-    STDMETHOD(COMGETTER(Initiator)) (IUnknown **aInitiator);
-
-    // IProgress properties
-    STDMETHOD(COMGETTER(Cancelable)) (BOOL *aCancelable);
-    STDMETHOD(COMGETTER(Percent)) (ULONG *aPercent);
-    STDMETHOD(COMGETTER(TimeRemaining)) (LONG *aTimeRemaining);
-    STDMETHOD(COMGETTER(Completed)) (BOOL *aCompleted);
-    STDMETHOD(COMGETTER(Canceled)) (BOOL *aCanceled);
-    STDMETHOD(COMGETTER(ResultCode)) (LONG *aResultCode);
-    STDMETHOD(COMGETTER(ErrorInfo)) (IVirtualBoxErrorInfo **aErrorInfo);
-    STDMETHOD(COMGETTER(OperationCount)) (ULONG *aOperationCount);
-    STDMETHOD(COMGETTER(Operation)) (ULONG *aCount);
-    STDMETHOD(COMGETTER(OperationDescription)) (BSTR *aOperationDescription);
-    STDMETHOD(COMGETTER(OperationPercent)) (ULONG *aOperationPercent);
-    STDMETHOD(COMSETTER(Timeout)) (ULONG aTimeout);
-    STDMETHOD(COMGETTER(Timeout)) (ULONG *aTimeout);
-
-    // public methods only for internal purposes
-
-    static HRESULT setErrorInfoOnThread (IProgress *aProgress);
-    bool setCancelCallback(void (*pfnCallback)(void *), void *pvUser);
-
-
-    // unsafe inline public methods for internal purposes only (ensure there is
-    // a caller and a read lock before calling them!)
-
-    BOOL getCompleted() const { return mCompleted; }
-    HRESULT getResultCode() const { return mResultCode; }
-    double calcTotalPercent();
-
-protected:
-    void checkForAutomaticTimeout(void);
-
-#if !defined (VBOX_COM_INPROC)
-    /** Weak parent. */
-    const ComObjPtr<VirtualBox, ComWeakRef> mParent;
-#endif
-
-    const ComPtr<IUnknown> mInitiator;
-
-    const Guid mId;
-    const Bstr 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 initalized 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()
-    Bstr m_bstrOperationDescription;                // 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. */
-};
-
-////////////////////////////////////////////////////////////////////////////////
-
-/**
- * Normal progress object.
- */
-class ATL_NO_VTABLE Progress :
-    public com::SupportErrorInfoDerived<ProgressBase, Progress, IProgress>,
-    public VirtualBoxSupportTranslation<Progress>
-{
-
-public:
-
-    VIRTUALBOXSUPPORTTRANSLATION_OVERRIDE (Progress)
-
-    DECLARE_NOT_AGGREGATABLE (Progress)
-
-    DECLARE_PROTECT_FINAL_CONSTRUCT()
-
-    BEGIN_COM_MAP (Progress)
-        COM_INTERFACE_ENTRY  (ISupportErrorInfo)
-        COM_INTERFACE_ENTRY  (IProgress)
-        COM_INTERFACE_ENTRY2 (IDispatch, IProgress)
-    END_COM_MAP()
-
-    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
-     * @param aId
-     * @return
-     */
-    HRESULT init(
-#if !defined (VBOX_COM_INPROC)
-                  VirtualBox *aParent,
-#endif
-                  IUnknown *aInitiator,
-                  CBSTR aDescription,
-                  BOOL aCancelable,
-                  OUT_GUID aId = NULL)
-    {
-        return init(
-#if !defined (VBOX_COM_INPROC)
-            aParent,
-#endif
-            aInitiator,
-            aDescription,
-            aCancelable,
-            1,      // cOperations
-            1,      // ulTotalOperationsWeight
-            aDescription, // bstrFirstOperationDescription
-            1,      // ulFirstOperationWeight
-            aId);
-    }
-
-    /**
-     * 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 bstrFirstOperationDescription
-     * @param aId
-     * @return
-     */
-    HRESULT init(
-#if !defined (VBOX_COM_INPROC)
-                  VirtualBox *aParent,
-#endif
-                  IUnknown *aInitiator,
-                  CBSTR aDescription, BOOL aCancelable,
-                  ULONG cOperations,
-                  CBSTR bstrFirstOperationDescription,
-                  OUT_GUID aId = NULL)
-    {
-        return init(
-#if !defined (VBOX_COM_INPROC)
-            aParent,
-#endif
-            aInitiator,
-            aDescription,
-            aCancelable,
-            cOperations,      // cOperations
-            cOperations,      // ulTotalOperationsWeight = cOperations
-            bstrFirstOperationDescription, // bstrFirstOperationDescription
-            1,      // ulFirstOperationWeight: weigh them all the same
-            aId);
-    }
-
-    HRESULT init(
-#if !defined (VBOX_COM_INPROC)
-                  VirtualBox *aParent,
-#endif
-                  IUnknown *aInitiator,
-                  CBSTR aDescription,
-                  BOOL aCancelable,
-                  ULONG cOperations,
-                  ULONG ulTotalOperationsWeight,
-                  CBSTR bstrFirstOperationDescription,
-                  ULONG ulFirstOperationWeight,
-                  OUT_GUID aId = NULL);
-
-    HRESULT init(BOOL aCancelable,
-                 ULONG aOperationCount,
-                 CBSTR aOperationDescription);
-
-    void uninit();
-
-    // IProgress methods
-    STDMETHOD(WaitForCompletion)(LONG aTimeout);
-    STDMETHOD(WaitForOperationCompletion)(ULONG aOperation, LONG aTimeout);
-    STDMETHOD(Cancel)();
-
-    STDMETHOD(SetCurrentOperationProgress)(ULONG aPercent);
-    STDMETHOD(SetNextOperation)(IN_BSTR bstrNextOperationDescription, ULONG ulNextOperationsWeight);
-
-    // public methods only for internal purposes
-
-    HRESULT setResultCode(HRESULT aResultCode);
-
-    HRESULT notifyComplete(HRESULT aResultCode);
-    HRESULT notifyComplete(HRESULT aResultCode,
-                           const GUID &aIID,
-                           const Bstr &aComponent,
-                           const char *aText, ...);
-    bool notifyPointOfNoReturn(void);
-
-    /** For com::SupportErrorInfoImpl. */
-    static const char *ComponentName() { return "Progress"; }
-
-private:
-
-    RTSEMEVENTMULTI mCompletedSem;
-    ULONG mWaitersCount;
-};
-
-////////////////////////////////////////////////////////////////////////////////
 
 /**
@@ -449 +195 @@
 };
 
-#endif /* ____H_PROGRESSIMPL */
+#endif /* ____H_PROGRESSCOMBINEDIMPL */