diff options
Diffstat (limited to 'src/VBox/Main/include/SnapshotImpl.h')
-rw-r--r-- | src/VBox/Main/include/SnapshotImpl.h | 142 |
1 files changed, 142 insertions, 0 deletions
diff --git a/src/VBox/Main/include/SnapshotImpl.h b/src/VBox/Main/include/SnapshotImpl.h new file mode 100644 index 00000000..ea6fd309 --- /dev/null +++ b/src/VBox/Main/include/SnapshotImpl.h @@ -0,0 +1,142 @@ +/* $Id: SnapshotImpl.h $ */ +/** @file + * VirtualBox COM class implementation + */ + +/* + * Copyright (C) 2006-2022 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_SnapshotImpl_h +#define MAIN_INCLUDED_SnapshotImpl_h +#ifndef RT_WITHOUT_PRAGMA_ONCE +# pragma once +#endif + +#include "SnapshotWrap.h" + +class SnapshotMachine; + +namespace settings +{ + struct Snapshot; +} + +class ATL_NO_VTABLE Snapshot : + public SnapshotWrap +{ +public: + DECLARE_COMMON_CLASS_METHODS(Snapshot) + + HRESULT FinalConstruct(); + void FinalRelease(); + + // public initializer/uninitializer only for internal purposes + HRESULT init(VirtualBox *aVirtualBox, + const Guid &aId, + const com::Utf8Str &aName, + const com::Utf8Str &aDescription, + const RTTIMESPEC &aTimeStamp, + SnapshotMachine *aMachine, + Snapshot *aParent); + void uninit(); + + void i_beginSnapshotDelete(); + + void i_deparent(); + + // public methods only for internal purposes + + /** + * Override of the default locking class to be used for validating lock + * order with the standard member lock handle. + */ + virtual VBoxLockingClass getLockingClass() const + { + return LOCKCLASS_SNAPSHOTOBJECT; + } + + const ComObjPtr<Snapshot>& i_getParent() const; + const ComObjPtr<Snapshot> i_getFirstChild() const; + + const Utf8Str& i_getStateFilePath() const; + + uint32_t i_getDepth(); + + ULONG i_getChildrenCount(); + ULONG i_getAllChildrenCount(); + + const ComObjPtr<SnapshotMachine>& i_getSnapshotMachine() const; + + Guid i_getId() const; + const Utf8Str& i_getName() const; + RTTIMESPEC i_getTimeStamp() const; + + ComObjPtr<Snapshot> i_findChildOrSelf(IN_GUID aId); + ComObjPtr<Snapshot> i_findChildOrSelf(const com::Utf8Str &aName); + + void i_updateSavedStatePaths(const Utf8Str &strOldPath, + const Utf8Str &strNewPath); + void i_updateSavedStatePathsImpl(const Utf8Str &strOldPath, + const Utf8Str &strNewPath); + + bool i_sharesSavedStateFile(const Utf8Str &strPath, + Snapshot *pSnapshotToIgnore); + + void i_updateNVRAMPaths(const Utf8Str &strOldPath, + const Utf8Str &strNewPath); + void i_updateNVRAMPathsImpl(const Utf8Str &strOldPath, + const Utf8Str &strNewPath); + + HRESULT i_saveSnapshotOne(settings::Snapshot &data) const; + HRESULT i_saveSnapshot(settings::Snapshot &data) const; + + HRESULT i_uninitAll(AutoWriteLock &writeLock, + CleanupMode_T cleanupMode, + MediaList &llMedia, + std::list<Utf8Str> &llFilenames); + + +private: + + struct Data; // opaque, defined in SnapshotImpl.cpp + + // wrapped ISnapshot properties + HRESULT getId(com::Guid &aId); + HRESULT getName(com::Utf8Str &aName); + HRESULT setName(const com::Utf8Str &aName); + HRESULT getDescription(com::Utf8Str &aDescription); + HRESULT setDescription(const com::Utf8Str &aDescription); + HRESULT getTimeStamp(LONG64 *aTimeStamp); + HRESULT getOnline(BOOL *aOnline); + HRESULT getMachine(ComPtr<IMachine> &aMachine); + HRESULT getParent(ComPtr<ISnapshot> &aParent); + HRESULT getChildren(std::vector<ComPtr<ISnapshot> > &aChildren); + + // wrapped ISnapshot methods + HRESULT getChildrenCount(ULONG *aChildrenCount); + + Data *m; +}; + +#endif /* !MAIN_INCLUDED_SnapshotImpl_h */ + +/* vi: set tabstop=4 shiftwidth=4 expandtab: */ |