Changeset 79051 in vbox

Timestamp:

Jun 8, 2019 10:43:14 PM (6 years ago)

Author:

vboxsync

svn:sync-xref-src-repo-rev:

131209

Message:

Main/AdditionsFacilityImpl: i_getName() shouldn't return a 'Utf8Str' object (copy) but 'const char *'. Can skip locking when accessing mType as it is static for the lifetime of the object. Some cleanups.

Location:

trunk/src/VBox/Main

Files:

• include/AdditionsFacilityImpl.h (modified) (2 diffs)
• src-client/AdditionsFacilityImpl.cpp (modified) (7 diffs)

trunk/src/VBox/Main/include/AdditionsFacilityImpl.h

@@ -58 +58 @@
     static const FacilityInfo s_aFacilityInfo[8];
 
-    // public internal methods
+    /** @name public internal methods
+     * @{ */
     static const AdditionsFacility::FacilityInfo &i_typeToInfo(AdditionsFacilityType_T aType);
+    LONG64 i_getLastUpdated() const;
+#if 0 /* unused */
+    AdditionsFacilityType_T i_getType() const;
     AdditionsFacilityClass_T i_getClass() const;
-    LONG64 i_getLastUpdated() const;
-    com::Utf8Str i_getName() const;
+    const char *i_getName() const;
+#endif
     AdditionsFacilityStatus_T i_getStatus() const;
-    AdditionsFacilityType_T i_getType() const;
     bool i_update(AdditionsFacilityStatus_T a_enmStatus, uint32_t a_fFlags, PCRTTIMESPEC a_pTimeSpecTS);
+    /** @} */
 
 private:
 
-    // Wrapped IAdditionsFacility properties
+    /** @name Wrapped IAdditionsFacility properties
+     * @{ */
     HRESULT getClassType(AdditionsFacilityClass_T *aClassType);
     HRESULT getLastUpdated(LONG64 *aLastUpdated);
@@ -75 +80 @@
     HRESULT getStatus(AdditionsFacilityStatus_T *aStatus);
     HRESULT getType(AdditionsFacilityType_T *aType);
+    /** @} */
 
     /** A structure for keeping a facility status

trunk/src/VBox/Main/src-client/AdditionsFacilityImpl.cpp

@@ -26 +26 @@
 
 
+/**
+ * @note We assume that unknown is always the first entry!
+ */
 /* static */
 const AdditionsFacility::FacilityInfo AdditionsFacility::s_aFacilityInfo[8] =
 {
-    /* NOTE: We assume that unknown is always the first entry! */
-    { "Unknown", AdditionsFacilityType_None, AdditionsFacilityClass_None },
-    { "VirtualBox Base Driver", AdditionsFacilityType_VBoxGuestDriver, AdditionsFacilityClass_Driver },
-    { "Auto Logon", AdditionsFacilityType_AutoLogon, AdditionsFacilityClass_Feature },
-    { "VirtualBox System Service", AdditionsFacilityType_VBoxService, AdditionsFacilityClass_Service },
-    { "VirtualBox Desktop Integration", AdditionsFacilityType_VBoxTrayClient, AdditionsFacilityClass_Program },
-    { "Seamless Mode", AdditionsFacilityType_Seamless, AdditionsFacilityClass_Feature },
-    { "Graphics Mode", AdditionsFacilityType_Graphics, AdditionsFacilityClass_Feature },
-    { "Guest Monitor Attach", AdditionsFacilityType_MonitorAttach, AdditionsFacilityClass_Feature },
+    { "Unknown",                        AdditionsFacilityType_None,             AdditionsFacilityClass_None },
+    { "VirtualBox Base Driver",         AdditionsFacilityType_VBoxGuestDriver,  AdditionsFacilityClass_Driver },
+    { "Auto Logon",                     AdditionsFacilityType_AutoLogon,        AdditionsFacilityClass_Feature },
+    { "VirtualBox System Service",      AdditionsFacilityType_VBoxService,      AdditionsFacilityClass_Service },
+    { "VirtualBox Desktop Integration", AdditionsFacilityType_VBoxTrayClient,   AdditionsFacilityClass_Program },
+    { "Seamless Mode",                  AdditionsFacilityType_Seamless,         AdditionsFacilityClass_Feature },
+    { "Graphics Mode",                  AdditionsFacilityType_Graphics,         AdditionsFacilityClass_Feature },
+    { "Guest Monitor Attach",           AdditionsFacilityType_MonitorAttach,    AdditionsFacilityClass_Feature },
 };
 
@@ -109 +111 @@
     LogFlowThisFuncEnter();
 
+    /* mType is static, so no need to lock anything. */
+    *aClassType = AdditionsFacility::i_typeToInfo(mData.mType).mClass;
+    return S_OK;
+}
+
+HRESULT AdditionsFacility::getName(com::Utf8Str &aName)
+{
+    LogFlowThisFuncEnter();
+
+    /* mType is static, so no need to lock anything. */
+    int vrc = aName.assignNoThrow(AdditionsFacility::i_typeToInfo(mData.mType).mName);
+    return RT_SUCCESS(vrc) ? S_OK : E_OUTOFMEMORY;
+}
+
+HRESULT AdditionsFacility::getLastUpdated(LONG64 *aLastUpdated)
+{
+    LogFlowThisFuncEnter();
+
     AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
 
-    *aClassType = i_getClass();
-
-    return S_OK;
-}
-
-HRESULT AdditionsFacility::getName(com::Utf8Str &aName)
+    *aLastUpdated = i_getLastUpdated();
+
+    return S_OK;
+}
+
+HRESULT AdditionsFacility::getStatus(AdditionsFacilityStatus_T *aStatus)
 {
     LogFlowThisFuncEnter();
@@ -122 +142 @@
     AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
 
-    aName = i_getName();
-
-    return S_OK;
-}
-
-HRESULT AdditionsFacility::getLastUpdated(LONG64 *aLastUpdated)
-{
-    LogFlowThisFuncEnter();
-
-    AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
-
-    *aLastUpdated = i_getLastUpdated();
-
-    return S_OK;
-}
-
-HRESULT AdditionsFacility::getStatus(AdditionsFacilityStatus_T *aStatus)
-{
-    LogFlowThisFuncEnter();
-
-    AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
-
     *aStatus = i_getStatus();
 
@@ -153 +151 @@
     LogFlowThisFuncEnter();
 
-    AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
-
-    *aType = i_getType();
-
-    return S_OK;
-}
-
-const AdditionsFacility::FacilityInfo &AdditionsFacility::i_typeToInfo(AdditionsFacilityType_T aType)
+    /* mType is static, so no need to lock anything. */
+    *aType = mData.mType;
+    return S_OK;
+}
+
+/*static*/ const AdditionsFacility::FacilityInfo &AdditionsFacility::i_typeToInfo(AdditionsFacilityType_T aType)
 {
     for (size_t i = 0; i < RT_ELEMENTS(s_aFacilityInfo); ++i)
@@ -170 +166 @@
 }
 
+#if 0 /* unused */
+
+AdditionsFacilityType_T AdditionsFacility::i_getType() const
+{
+    return mData.mType;
+}
+
 AdditionsFacilityClass_T AdditionsFacility::i_getClass() const
 {
@@ -175 +178 @@
 }
 
-com::Utf8Str AdditionsFacility::i_getName() const
+const char *AdditionsFacility::i_getName() const
 {
     return AdditionsFacility::i_typeToInfo(mData.mType).mName;
 }
+
+#endif
 
 LONG64 AdditionsFacility::i_getLastUpdated() const
@@ -196 +201 @@
     AssertMsgFailed(("Unknown status of facility!\n"));
     return AdditionsFacilityStatus_Unknown; /* Should never happen! */
-}
-
-AdditionsFacilityType_T AdditionsFacility::i_getType() const
-{
-    return mData.mType;
 }