Changeset 92876 in vbox

Timestamp:

Dec 12, 2021 3:00:02 AM (3 years ago)

Author:

vboxsync

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

148824

Message:

Main/GuestSessionImpl: Comment update, two todos. bugref:9320

Location:

trunk/src/VBox/Main

Files:

• include/GuestSessionImpl.h (modified) (3 diffs)
• src-client/GuestSessionImpl.cpp (modified) (1 diff)

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

@@ -242 +242 @@
     enum SESSIONOBJECTTYPE
     {
+        /** @todo r=bird: The tradition is to start at = 1, leaving 0 for invalid or
+         * unused to catch uninitialized data.  You do not number the other enum values.
+         * The 32BIT_HACK is only needed for externally visible stuff that might be used
+         * by with different compiler options.
+         *
+         * As noted elsewhere already, SESSIONOBJECTTYPE_ANONYMOUS isn't used
+         * anywhere can be removed till such time as it is needed.  Try to not think
+         * too far ahead but if you do, please leave some more useful clues that
+         * "Anonymous object" about the intent. */
         /** Anonymous object. */
         SESSIONOBJECTTYPE_ANONYMOUS  = 0,
@@ -263 +272 @@
         /** The object type. */
         SESSIONOBJECTTYPE enmType;
-        /** Weak pointer to the object itself. */
+        /** Weak pointer to the object itself.
+         * Is NULL for SESSIONOBJECTTYPE_SESSION because GuestSession doesn't
+         * inherit from GuestObject. */
         GuestObject      *pObject;
     };
@@ -269 +280 @@
     /** Map containing all objects bound to a guest session.
      *  The key specifies the (global) context ID. */
-    typedef std::map <uint32_t, SessionObject> SessionObjects;
+    typedef std::map<uint32_t, SessionObject> SessionObjects;
 
 public:

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

@@ -1249 +1249 @@
         pCtxCb->uProtocol = mData.mProtocolVersion;
 
+        /** @todo r=bird: What is the meaning of this secondary lookup?  You've got the
+         * object pointer (except for SESSION where it's NULL because GuestSession
+         * doesn't inherit from GuestObject), and can just use the type to upcast it to
+         * grab a reference then call i_callbackDispatcher.
+         *
+         * Also, SESSIONOBJECTTYPE_ANONYMOUS is not used to remove it till needed.
+         * Don't think too far ahead, and when you do, please express why you think it
+         * is needed (the documentation of SESSIONOBJECTTYPE_ANONYMOUS is only repeating
+         * the obvious and not enlightening as to why you though it might come in
+         * useful).
+         */
         switch (itObjs->second.enmType)
         {