/* $Id: MediumFormatImpl.h 98103 2023-01-17 14:15:46Z vboxsync $ */ /** @file * MediumFormat COM class implementation */ /* * Copyright (C) 2008-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 . * * SPDX-License-Identifier: GPL-3.0-only */ #ifndef MAIN_INCLUDED_MediumFormatImpl_h #define MAIN_INCLUDED_MediumFormatImpl_h #ifndef RT_WITHOUT_PRAGMA_ONCE # pragma once #endif #include "MediumFormatWrap.h" struct VDBACKENDINFO; /** * The MediumFormat class represents the backend used to store medium data * (IMediumFormat interface). * * @note Instances of this class are permanently caller-referenced by Medium * objects (through addCaller()) so that an attempt to uninitialize or delete * them before all Medium objects are uninitialized will produce an endless * wait! */ class ATL_NO_VTABLE MediumFormat : public MediumFormatWrap { public: struct Property { Utf8Str strName; Utf8Str strDescription; DataType_T type; ULONG flags; Utf8Str strDefaultValue; }; typedef std::vector PropertyArray; typedef std::vector StrArray; DECLARE_COMMON_CLASS_METHODS(MediumFormat) HRESULT FinalConstruct(); void FinalRelease(); // public initializer/uninitializer for internal purposes only HRESULT init(const VDBACKENDINFO *aVDInfo); void uninit(); // public methods for internal purposes only // (ensure there is a caller and a read lock before calling them!) /** Const, no need to lock */ const Utf8Str &i_getId() const { return m.strId; } /** Const, no need to lock */ const Utf8Str &i_getName() const { return m.strName; } /** Const, no need to lock */ const StrArray &i_getFileExtensions() const { return m.maFileExtensions; } /** Const, no need to lock */ MediumFormatCapabilities_T i_getCapabilities() const { return m.capabilities; } /** Const, no need to lock */ const PropertyArray &i_getProperties() const { return m.maProperties; } private: // wrapped IMediumFormat properties HRESULT getId(com::Utf8Str &aId); HRESULT getName(com::Utf8Str &aName); HRESULT getCapabilities(std::vector &aCapabilities); // wrapped IMediumFormat methods HRESULT describeFileExtensions(std::vector &aExtensions, std::vector &aTypes); HRESULT describeProperties(std::vector &aNames, std::vector &aDescriptions, std::vector &aTypes, std::vector &aFlags, std::vector &aDefaults); // types typedef std::vector DeviceTypeArray; // data struct Data { Data() : capabilities((MediumFormatCapabilities_T)0) {} const Utf8Str strId; const Utf8Str strName; const StrArray maFileExtensions; const DeviceTypeArray maDeviceTypes; const MediumFormatCapabilities_T capabilities; const PropertyArray maProperties; }; Data m; }; #endif /* !MAIN_INCLUDED_MediumFormatImpl_h */ /* vi: set tabstop=4 shiftwidth=4 expandtab: */