1 | /* $Id: MediumFormatImpl.h 72900 2018-07-04 19:42:18Z vboxsync $ */
|
---|
2 |
|
---|
3 | /** @file
|
---|
4 | *
|
---|
5 | * MediumFormat COM class implementation
|
---|
6 | */
|
---|
7 |
|
---|
8 | /*
|
---|
9 | * Copyright (C) 2008-2017 Oracle Corporation
|
---|
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 |
|
---|
20 | #ifndef MEDIUMFORMAT_IMPL_H_
|
---|
21 | #define MEDIUMFORMAT_IMPL_H_
|
---|
22 |
|
---|
23 | #include "MediumFormatWrap.h"
|
---|
24 |
|
---|
25 |
|
---|
26 | struct VDBACKENDINFO;
|
---|
27 |
|
---|
28 | /**
|
---|
29 | * The MediumFormat class represents the backend used to store medium data
|
---|
30 | * (IMediumFormat interface).
|
---|
31 | *
|
---|
32 | * @note Instances of this class are permanently caller-referenced by Medium
|
---|
33 | * objects (through addCaller()) so that an attempt to uninitialize or delete
|
---|
34 | * them before all Medium objects are uninitialized will produce an endless
|
---|
35 | * wait!
|
---|
36 | */
|
---|
37 | class ATL_NO_VTABLE MediumFormat :
|
---|
38 | public MediumFormatWrap
|
---|
39 | {
|
---|
40 | public:
|
---|
41 |
|
---|
42 | struct Property
|
---|
43 | {
|
---|
44 | Utf8Str strName;
|
---|
45 | Utf8Str strDescription;
|
---|
46 | DataType_T type;
|
---|
47 | ULONG flags;
|
---|
48 | Utf8Str strDefaultValue;
|
---|
49 | };
|
---|
50 |
|
---|
51 | typedef std::vector<Property> PropertyArray;
|
---|
52 | typedef std::vector<com::Utf8Str> StrArray;
|
---|
53 |
|
---|
54 | DECLARE_EMPTY_CTOR_DTOR(MediumFormat)
|
---|
55 |
|
---|
56 | HRESULT FinalConstruct();
|
---|
57 | void FinalRelease();
|
---|
58 |
|
---|
59 | // public initializer/uninitializer for internal purposes only
|
---|
60 | HRESULT init(const VDBACKENDINFO *aVDInfo);
|
---|
61 | void uninit();
|
---|
62 |
|
---|
63 | // public methods for internal purposes only
|
---|
64 | // (ensure there is a caller and a read lock before calling them!)
|
---|
65 |
|
---|
66 | /** Const, no need to lock */
|
---|
67 | const Utf8Str &i_getId() const { return m.strId; }
|
---|
68 | /** Const, no need to lock */
|
---|
69 | const Utf8Str &i_getName() const { return m.strName; }
|
---|
70 | /** Const, no need to lock */
|
---|
71 | const StrArray &i_getFileExtensions() const { return m.maFileExtensions; }
|
---|
72 | /** Const, no need to lock */
|
---|
73 | MediumFormatCapabilities_T i_getCapabilities() const { return m.capabilities; }
|
---|
74 | /** Const, no need to lock */
|
---|
75 | const PropertyArray &i_getProperties() const { return m.maProperties; }
|
---|
76 |
|
---|
77 | private:
|
---|
78 |
|
---|
79 | // wrapped IMediumFormat properties
|
---|
80 | HRESULT getId(com::Utf8Str &aId);
|
---|
81 | HRESULT getName(com::Utf8Str &aName);
|
---|
82 | HRESULT getCapabilities(std::vector<MediumFormatCapabilities_T> &aCapabilities);
|
---|
83 |
|
---|
84 | // wrapped IMediumFormat methods
|
---|
85 | HRESULT describeFileExtensions(std::vector<com::Utf8Str> &aExtensions,
|
---|
86 | std::vector<DeviceType_T> &aTypes);
|
---|
87 | HRESULT describeProperties(std::vector<com::Utf8Str> &aNames,
|
---|
88 | std::vector<com::Utf8Str> &aDescriptions,
|
---|
89 | std::vector<DataType_T> &aTypes,
|
---|
90 | std::vector<ULONG> &aFlags,
|
---|
91 | std::vector<com::Utf8Str> &aDefaults);
|
---|
92 |
|
---|
93 | // types
|
---|
94 | typedef std::vector<DeviceType_T> DeviceTypeArray;
|
---|
95 |
|
---|
96 | // data
|
---|
97 | struct Data
|
---|
98 | {
|
---|
99 | Data() : capabilities((MediumFormatCapabilities_T)0) {}
|
---|
100 |
|
---|
101 | const Utf8Str strId;
|
---|
102 | const Utf8Str strName;
|
---|
103 | const StrArray maFileExtensions;
|
---|
104 | const DeviceTypeArray maDeviceTypes;
|
---|
105 | const MediumFormatCapabilities_T capabilities;
|
---|
106 | const PropertyArray maProperties;
|
---|
107 | };
|
---|
108 |
|
---|
109 | Data m;
|
---|
110 | };
|
---|
111 |
|
---|
112 | #endif // MEDIUMFORMAT_IMPL_H_
|
---|
113 |
|
---|
114 | /* vi: set tabstop=4 shiftwidth=4 expandtab: */
|
---|