| 1 | /* $Id$ */
|
|---|
| 2 |
|
|---|
| 3 | /** @file
|
|---|
| 4 | *
|
|---|
| 5 | * VirtualBox COM class implementation
|
|---|
| 6 | */
|
|---|
| 7 |
|
|---|
| 8 | /*
|
|---|
| 9 | * Copyright (C) 2008-2009 Sun Microsystems, Inc.
|
|---|
| 10 | *
|
|---|
| 11 | * This file is part of VirtualBox Open Source Edition (OSE), as
|
|---|
| 12 | * available from http://www.virtualbox.org. This file is free software;
|
|---|
| 13 | * you can redistribute it and/or modify it under the terms of the GNU
|
|---|
| 14 | * General Public License (GPL) as published by the Free Software
|
|---|
| 15 | * Foundation, in version 2 as it comes in the "COPYING" file of the
|
|---|
| 16 | * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
|
|---|
| 17 | * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
|
|---|
| 18 | *
|
|---|
| 19 | * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
|
|---|
| 20 | * Clara, CA 95054 USA or visit http://www.sun.com if you need
|
|---|
| 21 | * additional information or have any questions.
|
|---|
| 22 | */
|
|---|
| 23 |
|
|---|
| 24 | #ifndef ____H_MEDIUMFORMAT
|
|---|
| 25 | #define ____H_MEDIUMFORMAT
|
|---|
| 26 |
|
|---|
| 27 | #include "VirtualBoxBase.h"
|
|---|
| 28 |
|
|---|
| 29 | #include <VBox/com/array.h>
|
|---|
| 30 |
|
|---|
| 31 | #include <list>
|
|---|
| 32 |
|
|---|
| 33 | struct VDBACKENDINFO;
|
|---|
| 34 |
|
|---|
| 35 | /**
|
|---|
| 36 | * The MediumFormat class represents the backend used to store medium data
|
|---|
| 37 | * (IMediumFormat interface).
|
|---|
| 38 | *
|
|---|
| 39 | * @note Instances of this class are permanently caller-referenced by Medium
|
|---|
| 40 | * objects (through addCaller()) so that an attempt to uninitialize or delete
|
|---|
| 41 | * them before all Medium objects are uninitialized will produce an endless
|
|---|
| 42 | * wait!
|
|---|
| 43 | */
|
|---|
| 44 | class ATL_NO_VTABLE MediumFormat :
|
|---|
| 45 | public VirtualBoxBase,
|
|---|
| 46 | public VirtualBoxSupportErrorInfoImpl<MediumFormat, IMediumFormat>,
|
|---|
| 47 | public VirtualBoxSupportTranslation<MediumFormat>,
|
|---|
| 48 | VBOX_SCRIPTABLE_IMPL(IMediumFormat)
|
|---|
| 49 | {
|
|---|
| 50 | public:
|
|---|
| 51 |
|
|---|
| 52 | struct Property
|
|---|
| 53 | {
|
|---|
| 54 | Bstr name;
|
|---|
| 55 | Bstr description;
|
|---|
| 56 | DataType_T type;
|
|---|
| 57 | ULONG flags;
|
|---|
| 58 | Bstr defaultValue;
|
|---|
| 59 | };
|
|---|
| 60 |
|
|---|
| 61 | typedef std::list <Bstr> BstrList;
|
|---|
| 62 | typedef std::list <Property> PropertyList;
|
|---|
| 63 |
|
|---|
| 64 | struct Data
|
|---|
| 65 | {
|
|---|
| 66 | Data() : capabilities (0) {}
|
|---|
| 67 |
|
|---|
| 68 | const Bstr id;
|
|---|
| 69 | const Bstr name;
|
|---|
| 70 | const BstrList fileExtensions;
|
|---|
| 71 | const uint64_t capabilities;
|
|---|
| 72 | const PropertyList properties;
|
|---|
| 73 | };
|
|---|
| 74 |
|
|---|
| 75 | VIRTUALBOXBASE_ADD_ERRORINFO_SUPPORT (MediumFormat)
|
|---|
| 76 |
|
|---|
| 77 | DECLARE_NOT_AGGREGATABLE (MediumFormat)
|
|---|
| 78 |
|
|---|
| 79 | DECLARE_PROTECT_FINAL_CONSTRUCT()
|
|---|
| 80 |
|
|---|
| 81 | BEGIN_COM_MAP(MediumFormat)
|
|---|
| 82 | COM_INTERFACE_ENTRY (ISupportErrorInfo)
|
|---|
| 83 | COM_INTERFACE_ENTRY (IMediumFormat)
|
|---|
| 84 | COM_INTERFACE_ENTRY (IDispatch)
|
|---|
| 85 | END_COM_MAP()
|
|---|
| 86 |
|
|---|
| 87 | DECLARE_EMPTY_CTOR_DTOR (MediumFormat)
|
|---|
| 88 |
|
|---|
| 89 | HRESULT FinalConstruct();
|
|---|
| 90 | void FinalRelease();
|
|---|
| 91 |
|
|---|
| 92 | // public initializer/uninitializer for internal purposes only
|
|---|
| 93 | HRESULT init (const VDBACKENDINFO *aVDInfo);
|
|---|
| 94 | void uninit();
|
|---|
| 95 |
|
|---|
| 96 | // IMediumFormat properties
|
|---|
| 97 | STDMETHOD(COMGETTER(Id)) (BSTR *aId);
|
|---|
| 98 | STDMETHOD(COMGETTER(Name)) (BSTR *aName);
|
|---|
| 99 | STDMETHOD(COMGETTER(FileExtensions)) (ComSafeArrayOut (BSTR, aFileExtensions));
|
|---|
| 100 | STDMETHOD(COMGETTER(Capabilities)) (ULONG *aCaps);
|
|---|
| 101 |
|
|---|
| 102 | // IMediumFormat methods
|
|---|
| 103 | STDMETHOD(DescribeProperties) (ComSafeArrayOut (BSTR, aNames),
|
|---|
| 104 | ComSafeArrayOut (BSTR, aDescriptions),
|
|---|
| 105 | ComSafeArrayOut (DataType_T, aTypes),
|
|---|
| 106 | ComSafeArrayOut (ULONG, aFlags),
|
|---|
| 107 | ComSafeArrayOut (BSTR, aDefaults));
|
|---|
| 108 |
|
|---|
| 109 | // public methods only for internal purposes
|
|---|
| 110 |
|
|---|
| 111 | // public methods for internal purposes only
|
|---|
| 112 | // (ensure there is a caller and a read lock before calling them!)
|
|---|
| 113 |
|
|---|
| 114 | /** Const, no need to lock */
|
|---|
| 115 | const Bstr &id() const { return m.id; }
|
|---|
| 116 | /** Const, no need to lock */
|
|---|
| 117 | const BstrList &fileExtensions() const { return m.fileExtensions; }
|
|---|
| 118 | /** Const, no need to lock */
|
|---|
| 119 | uint64_t capabilities() const { return m.capabilities; }
|
|---|
| 120 | /** Const, no need to lock */
|
|---|
| 121 | const PropertyList &properties() const { return m.properties; }
|
|---|
| 122 |
|
|---|
| 123 | // for VirtualBoxSupportErrorInfoImpl
|
|---|
| 124 | static const wchar_t *getComponentName() { return L"MediumFormat"; }
|
|---|
| 125 |
|
|---|
| 126 | private:
|
|---|
| 127 |
|
|---|
| 128 | Data m;
|
|---|
| 129 | };
|
|---|
| 130 |
|
|---|
| 131 | #endif // ____H_MEDIUMFORMAT
|
|---|
| 132 |
|
|---|
| 133 | /* vi: set tabstop=4 shiftwidth=4 expandtab: */
|
|---|
