VirtualBox

source: vbox/trunk/src/VBox/Main/include/SystemPropertiesImpl.h

Last change on this file was 103977, checked in by vboxsync, 7 weeks ago

Apply RT_OVERRIDE/NS_OVERRIDE where required to shut up clang.
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 10.1 KB
Line 
1/* $Id: SystemPropertiesImpl.h 103977 2024-03-21 02:04:52Z vboxsync $ */
2
3/** @file
4 *
5 * VirtualBox COM class implementation
6 */
7
8/*
9 * Copyright (C) 2006-2023 Oracle and/or its affiliates.
10 *
11 * This file is part of VirtualBox base platform packages, as
12 * available from https://www.virtualbox.org.
13 *
14 * This program is free software; you can redistribute it and/or
15 * modify it under the terms of the GNU General Public License
16 * as published by the Free Software Foundation, in version 3 of the
17 * License.
18 *
19 * This program is distributed in the hope that it will be useful, but
20 * WITHOUT ANY WARRANTY; without even the implied warranty of
21 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
22 * General Public License for more details.
23 *
24 * You should have received a copy of the GNU General Public License
25 * along with this program; if not, see <https://www.gnu.org/licenses>.
26 *
27 * SPDX-License-Identifier: GPL-3.0-only
28 */
29
30#ifndef MAIN_INCLUDED_SystemPropertiesImpl_h
31#define MAIN_INCLUDED_SystemPropertiesImpl_h
32#ifndef RT_WITHOUT_PRAGMA_ONCE
33# pragma once
34#endif
35
36#include "MediumFormatImpl.h"
37#include "SystemPropertiesWrap.h"
38
39class CPUProfile;
40class PlatformProperties;
41
42namespace settings
43{
44 struct SystemProperties;
45}
46
47class ATL_NO_VTABLE SystemProperties :
48 public SystemPropertiesWrap
49{
50public:
51 typedef std::list<ComObjPtr<MediumFormat> > MediumFormatList;
52 typedef std::list<ComObjPtr<CPUProfile> > CPUProfileList_T;
53
54 DECLARE_COMMON_CLASS_METHODS(SystemProperties)
55
56 HRESULT FinalConstruct();
57 void FinalRelease();
58
59 // public initializer/uninitializer for internal purposes only
60 HRESULT init(VirtualBox *aParent);
61 void uninit() RT_OVERRIDE;
62
63 // public methods for internal purposes only
64 // (ensure there is a caller and a read lock before calling them!)
65 HRESULT i_loadSettings(const settings::SystemProperties &data);
66 HRESULT i_saveSettings(settings::SystemProperties &data);
67
68 ComObjPtr<MediumFormat> i_mediumFormat(const Utf8Str &aFormat);
69 ComObjPtr<MediumFormat> i_mediumFormatFromExtension(const Utf8Str &aExt);
70
71 int i_loadVDPlugin(const char *pszPluginLibrary);
72 int i_unloadVDPlugin(const char *pszPluginLibrary);
73
74 HRESULT i_getDefaultAdditionsISO(com::Utf8Str &aDefaultAdditionsISO);
75
76private:
77
78 // wrapped ISystemProperties properties
79 HRESULT getMinGuestRAM(ULONG *aMinGuestRAM) RT_OVERRIDE;
80 HRESULT getMaxGuestRAM(ULONG *aMaxGuestRAM) RT_OVERRIDE;
81 HRESULT getMinGuestVRAM(ULONG *aMinGuestVRAM) RT_OVERRIDE;
82 HRESULT getMaxGuestVRAM(ULONG *aMaxGuestVRAM) RT_OVERRIDE;
83 HRESULT getMinGuestCPUCount(ULONG *aMinGuestCPUCount) RT_OVERRIDE;
84 HRESULT getMaxGuestCPUCount(ULONG *aMaxGuestCPUCount) RT_OVERRIDE;
85 HRESULT getMaxGuestMonitors(ULONG *aMaxGuestMonitors) RT_OVERRIDE;
86 HRESULT getInfoVDSize(LONG64 *aInfoVDSize) RT_OVERRIDE;
87 HRESULT getDefaultMachineFolder(com::Utf8Str &aDefaultMachineFolder) RT_OVERRIDE;
88 HRESULT setDefaultMachineFolder(const com::Utf8Str &aDefaultMachineFolder) RT_OVERRIDE;
89 HRESULT getLoggingLevel(com::Utf8Str &aLoggingLevel) RT_OVERRIDE;
90 HRESULT setLoggingLevel(const com::Utf8Str &aLoggingLevel) RT_OVERRIDE;
91 HRESULT getMediumFormats(std::vector<ComPtr<IMediumFormat> > &aMediumFormats) RT_OVERRIDE;
92 HRESULT getDefaultHardDiskFormat(com::Utf8Str &aDefaultHardDiskFormat) RT_OVERRIDE;
93 HRESULT setDefaultHardDiskFormat(const com::Utf8Str &aDefaultHardDiskFormat) RT_OVERRIDE;
94 HRESULT getFreeDiskSpaceWarning(LONG64 *aFreeDiskSpaceWarning) RT_OVERRIDE;
95 HRESULT setFreeDiskSpaceWarning(LONG64 aFreeDiskSpaceWarning) RT_OVERRIDE;
96 HRESULT getFreeDiskSpacePercentWarning(ULONG *aFreeDiskSpacePercentWarning) RT_OVERRIDE;
97 HRESULT setFreeDiskSpacePercentWarning(ULONG aFreeDiskSpacePercentWarning) RT_OVERRIDE;
98 HRESULT getFreeDiskSpaceError(LONG64 *aFreeDiskSpaceError) RT_OVERRIDE;
99 HRESULT setFreeDiskSpaceError(LONG64 aFreeDiskSpaceError) RT_OVERRIDE;
100 HRESULT getFreeDiskSpacePercentError(ULONG *aFreeDiskSpacePercentError) RT_OVERRIDE;
101 HRESULT setFreeDiskSpacePercentError(ULONG aFreeDiskSpacePercentError) RT_OVERRIDE;
102 HRESULT getVRDEAuthLibrary(com::Utf8Str &aVRDEAuthLibrary) RT_OVERRIDE;
103 HRESULT setVRDEAuthLibrary(const com::Utf8Str &aVRDEAuthLibrary) RT_OVERRIDE;
104 HRESULT getWebServiceAuthLibrary(com::Utf8Str &aWebServiceAuthLibrary) RT_OVERRIDE;
105 HRESULT setWebServiceAuthLibrary(const com::Utf8Str &aWebServiceAuthLibrary) RT_OVERRIDE;
106 HRESULT getDefaultVRDEExtPack(com::Utf8Str &aDefaultVRDEExtPack) RT_OVERRIDE;
107 HRESULT setDefaultVRDEExtPack(const com::Utf8Str &aDefaultVRDEExtPack) RT_OVERRIDE;
108 HRESULT getDefaultCryptoExtPack(com::Utf8Str &aDefaultCryptoExtPack) RT_OVERRIDE;
109 HRESULT setDefaultCryptoExtPack(const com::Utf8Str &aDefaultCryptoExtPack) RT_OVERRIDE;
110 HRESULT getLogHistoryCount(ULONG *aLogHistoryCount) RT_OVERRIDE;
111 HRESULT setLogHistoryCount(ULONG aLogHistoryCount) RT_OVERRIDE;
112 HRESULT getDefaultAudioDriver(AudioDriverType_T *aDefaultAudioDriver) RT_OVERRIDE;
113 HRESULT getAutostartDatabasePath(com::Utf8Str &aAutostartDatabasePath) RT_OVERRIDE;
114 HRESULT setAutostartDatabasePath(const com::Utf8Str &aAutostartDatabasePath) RT_OVERRIDE;
115 HRESULT getDefaultAdditionsISO(com::Utf8Str &aDefaultAdditionsISO) RT_OVERRIDE;
116 HRESULT setDefaultAdditionsISO(const com::Utf8Str &aDefaultAdditionsISO) RT_OVERRIDE;
117 HRESULT getDefaultFrontend(com::Utf8Str &aDefaultFrontend) RT_OVERRIDE;
118 HRESULT setDefaultFrontend(const com::Utf8Str &aDefaultFrontend) RT_OVERRIDE;
119 HRESULT getScreenShotFormats(std::vector<BitmapFormat_T> &aScreenShotFormats) RT_OVERRIDE;
120 HRESULT getPlatform(ComPtr<IPlatformProperties> &aPlatformProperties) RT_OVERRIDE;
121 HRESULT getProxyMode(ProxyMode_T *pProxyMode) RT_OVERRIDE;
122 HRESULT setProxyMode(ProxyMode_T aProxyMode) RT_OVERRIDE;
123 HRESULT getProxyURL(com::Utf8Str &aProxyURL) RT_OVERRIDE;
124 HRESULT setProxyURL(const com::Utf8Str &aProxyURL) RT_OVERRIDE;
125 HRESULT getSupportedPlatformArchitectures(std::vector<PlatformArchitecture_T> &aSupportedPlatformArchitectures) RT_OVERRIDE;
126 HRESULT getSupportedClipboardModes(std::vector<ClipboardMode_T> &aSupportedClipboardModes) RT_OVERRIDE;
127 HRESULT getSupportedDnDModes(std::vector<DnDMode_T> &aSupportedDnDModes) RT_OVERRIDE;
128 HRESULT getSupportedPointingHIDTypes(std::vector<PointingHIDType_T> &aSupportedPointingHIDTypes) RT_OVERRIDE;
129 HRESULT getSupportedKeyboardHIDTypes(std::vector<KeyboardHIDType_T> &aSupportedKeyboardHIDTypes) RT_OVERRIDE;
130 HRESULT getSupportedVFSTypes(std::vector<VFSType_T> &aSupportedVFSTypes) RT_OVERRIDE;
131 HRESULT getSupportedImportOptions(std::vector<ImportOptions_T> &aSupportedImportOptions) RT_OVERRIDE;
132 HRESULT getSupportedExportOptions(std::vector<ExportOptions_T> &aSupportedExportOptions) RT_OVERRIDE;
133 HRESULT getSupportedRecordingFeatures(std::vector<RecordingFeature_T> &aSupportedRecordingFeatures) RT_OVERRIDE;
134 HRESULT getSupportedRecordingAudioCodecs(std::vector<RecordingAudioCodec_T> &aSupportedRecordingAudioCodecs) RT_OVERRIDE;
135 HRESULT getSupportedRecordingVideoCodecs(std::vector<RecordingVideoCodec_T> &aSupportedRecordingVideoCodecs) RT_OVERRIDE;
136 HRESULT getSupportedRecordingVSModes(std::vector<RecordingVideoScalingMode_T> &aSupportedRecordingVideoScalingModes) RT_OVERRIDE;
137 HRESULT getSupportedRecordingARCModes(std::vector<RecordingRateControlMode_T> &aSupportedRecordingAudioRateControlModes) RT_OVERRIDE;
138 HRESULT getSupportedRecordingVRCModes(std::vector<RecordingRateControlMode_T> &aSupportedRecordingVideoRateControlModes) RT_OVERRIDE;
139 HRESULT getSupportedCloneOptions(std::vector<CloneOptions_T> &aSupportedCloneOptions) RT_OVERRIDE;
140 HRESULT getSupportedAutostopTypes(std::vector<AutostopType_T> &aSupportedAutostopTypes) RT_OVERRIDE;
141 HRESULT getSupportedVMProcPriorities(std::vector<VMProcPriority_T> &aSupportedVMProcPriorities) RT_OVERRIDE;
142 HRESULT getSupportedNetworkAttachmentTypes(std::vector<NetworkAttachmentType_T> &aSupportedNetworkAttachmentTypes) RT_OVERRIDE;
143 HRESULT getSupportedPortModes(std::vector<PortMode_T> &aSupportedPortModes) RT_OVERRIDE;
144 HRESULT getSupportedAudioDriverTypes(std::vector<AudioDriverType_T> &aSupportedAudioDriverTypes) RT_OVERRIDE;
145 HRESULT getLanguageId(com::Utf8Str &aLanguageId) RT_OVERRIDE;
146 HRESULT setLanguageId(const com::Utf8Str &aLanguageId) RT_OVERRIDE;
147
148 // wrapped ISystemProperties methods
149 HRESULT getDefaultIoCacheSettingForStorageController(StorageControllerType_T aControllerType,
150 BOOL *aEnabled) RT_OVERRIDE;
151 HRESULT getCPUProfiles(CPUArchitecture_T aArchitecture, const com::Utf8Str &aNamePattern,
152 std::vector<ComPtr<ICPUProfile> > &aProfiles) RT_OVERRIDE;
153 HRESULT getExecutionEnginesForVmCpuArchitecture(CPUArchitecture_T aCpuArchitecture,
154 std::vector<VMExecutionEngine_T> &aExecutionEngines) RT_OVERRIDE;
155
156 HRESULT i_getUserHomeDirectory(Utf8Str &strPath);
157 HRESULT i_setDefaultMachineFolder(const Utf8Str &strPath);
158 HRESULT i_setLoggingLevel(const com::Utf8Str &aLoggingLevel);
159 HRESULT i_setDefaultHardDiskFormat(const com::Utf8Str &aFormat);
160 HRESULT i_setVRDEAuthLibrary(const com::Utf8Str &aPath);
161
162 HRESULT i_setWebServiceAuthLibrary(const com::Utf8Str &aPath);
163 HRESULT i_setDefaultVRDEExtPack(const com::Utf8Str &aExtPack);
164 HRESULT i_setDefaultCryptoExtPack(const com::Utf8Str &aExtPack);
165 HRESULT i_setAutostartDatabasePath(const com::Utf8Str &aPath);
166 HRESULT i_setDefaultAdditionsISO(const com::Utf8Str &aPath);
167 HRESULT i_setDefaultFrontend(const com::Utf8Str &aDefaultFrontend);
168
169 VirtualBox * const mParent;
170
171 settings::SystemProperties *m;
172
173 MediumFormatList m_llMediumFormats;
174
175 ComObjPtr<PlatformProperties> const m_platformProperties; /**< The host's platform properties. */
176 bool m_fLoadedX86CPUProfiles; /**< Set if we've loaded the x86 and AMD64 CPU profiles. */
177 CPUProfileList_T m_llCPUProfiles; /**< List of loaded CPU profiles. */
178
179 friend class VirtualBox;
180};
181
182#endif /* !MAIN_INCLUDED_SystemPropertiesImpl_h */
183/* vi: set tabstop=4 shiftwidth=4 expandtab: */
Note: See TracBrowser for help on using the repository browser.

© 2023 Oracle
Contact – Privacy policy – Terms of Use