summaryrefslogtreecommitdiffstats
path: root/src/VBox/Main/include/AdditionsFacilityImpl.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/VBox/Main/include/AdditionsFacilityImpl.h')
-rw-r--r--src/VBox/Main/include/AdditionsFacilityImpl.h110
1 files changed, 110 insertions, 0 deletions
diff --git a/src/VBox/Main/include/AdditionsFacilityImpl.h b/src/VBox/Main/include/AdditionsFacilityImpl.h
new file mode 100644
index 00000000..c6e565b1
--- /dev/null
+++ b/src/VBox/Main/include/AdditionsFacilityImpl.h
@@ -0,0 +1,110 @@
+/* $Id: AdditionsFacilityImpl.h $ */
+/** @file
+ * VirtualBox Main - Additions facility class.
+ */
+
+/*
+ * Copyright (C) 2014-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 <https://www.gnu.org/licenses>.
+ *
+ * SPDX-License-Identifier: GPL-3.0-only
+ */
+
+#ifndef MAIN_INCLUDED_AdditionsFacilityImpl_h
+#define MAIN_INCLUDED_AdditionsFacilityImpl_h
+#ifndef RT_WITHOUT_PRAGMA_ONCE
+# pragma once
+#endif
+
+#include <iprt/time.h>
+#include "AdditionsFacilityWrap.h"
+
+class Guest;
+
+/**
+ * A Guest Additions facility.
+ */
+class ATL_NO_VTABLE AdditionsFacility :
+ public AdditionsFacilityWrap
+{
+public:
+
+ DECLARE_COMMON_CLASS_METHODS(AdditionsFacility)
+
+ /** @name Initializer & uninitializer methods
+ * @{ */
+ HRESULT init(Guest *a_pParent, AdditionsFacilityType_T a_enmFacility, AdditionsFacilityStatus_T a_enmStatus,
+ uint32_t a_fFlags, PCRTTIMESPEC a_pTimeSpecTS);
+ void uninit();
+ HRESULT FinalConstruct();
+ void FinalRelease();
+ /** @} */
+
+public:
+ /** @name public internal methods
+ * @{ */
+ LONG64 i_getLastUpdated() const;
+#if 0 /* unused */
+ AdditionsFacilityType_T i_getType() const;
+ AdditionsFacilityClass_T i_getClass() const;
+ const char *i_getName() const;
+#endif
+ AdditionsFacilityStatus_T i_getStatus() const;
+ bool i_update(AdditionsFacilityStatus_T a_enmStatus, uint32_t a_fFlags, PCRTTIMESPEC a_pTimeSpecTS);
+ /** @} */
+
+private:
+
+ /** @name Wrapped IAdditionsFacility properties
+ * @{ */
+ HRESULT getClassType(AdditionsFacilityClass_T *aClassType);
+ HRESULT getLastUpdated(LONG64 *aLastUpdated);
+ HRESULT getName(com::Utf8Str &aName);
+ HRESULT getStatus(AdditionsFacilityStatus_T *aStatus);
+ HRESULT getType(AdditionsFacilityType_T *aType);
+ /** @} */
+
+ struct Data
+ {
+ /** Last update timestamp. */
+ RTTIMESPEC mTimestamp;
+ /** The facilitie's current status. */
+ AdditionsFacilityStatus_T mStatus;
+ /** Flags. */
+ uint32_t mfFlags;
+ /** The facilitie's ID/type (static). */
+ AdditionsFacilityType_T mType;
+ /** Index into s_aFacilityInfo. */
+ size_t midxInfo;
+ } mData;
+
+ /** Facility <-> string mappings. */
+ struct FacilityInfo
+ {
+ /** The facilitie's name. */
+ const char *mName; /* utf-8 */
+ /** The facilitie's type. */
+ AdditionsFacilityType_T mType;
+ /** The facilitie's class. */
+ AdditionsFacilityClass_T mClass;
+ };
+ static const FacilityInfo s_aFacilityInfo[8];
+};
+
+#endif /* !MAIN_INCLUDED_AdditionsFacilityImpl_h */
+