Changeset 2961 in vbox

Timestamp:

May 31, 2007 11:46:15 AM (18 years ago)

Author:

vboxsync

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

21653

Message:

Main: Added the IMachine::logFolder property and corrected changeset:21642.

Location:

trunk/src/VBox/Main

Files:

• ConsoleImpl.cpp (modified) (1 diff)
• HostDVDDriveImpl.cpp (modified) (4 diffs)
• HostFloppyDriveImpl.cpp (modified) (4 diffs)
• MachineImpl.cpp (modified) (3 diffs)
• idl/VirtualBox.xidl (modified) (6 diffs)
• include/HostDVDDriveImpl.h (modified) (2 diffs)
• include/HostFloppyDriveImpl.h (modified) (2 diffs)
• include/MachineImpl.h (modified) (2 diffs)

trunk/src/VBox/Main/ConsoleImpl.cpp

@@ -6522 +6522 @@
 
         Bstr logFolder;
-        hrc = console->mControl->GetLogFolder (logFolder.asOutParam());
+        hrc = console->mMachine->COMGETTER(LogFolder) (logFolder.asOutParam());
         CheckComRCBreakRC (hrc);
 

trunk/src/VBox/Main/HostDVDDriveImpl.cpp

@@ -44 +44 @@
  *
  * @param aName         Name of the drive.
+ * @param aUdi          Universal device identifier (currently may be NULL).
  * @param aDescription  Human-readable drive description (may be NULL).
  *
@@ -101 +102 @@
 }
 
-/**
- * Returns a human readable description of the host drive
- *
- * @returns COM status code
- * @param driveDescription address of result pointer
- */
 STDMETHODIMP HostDVDDrive::COMGETTER(Description) (BSTR *aDescription)
 {
@@ -122 +117 @@
 }
 
-/**
- * Returns the universal device identifier of the host drive
- *
- * @returns COM status code
- * @param driveDescription address of result pointer
- */
 STDMETHODIMP HostDVDDrive::COMGETTER(Udi) (BSTR *aUdi)
 {
@@ -136 +125 @@
     CheckComRCReturnRC (autoCaller.rc());
 
-    /* mDescription is constant during life time, no need to lock */
+    /* mUdi is constant during life time, no need to lock */
 
     mUdi.cloneTo (aUdi);

trunk/src/VBox/Main/HostFloppyDriveImpl.cpp

@@ -44 +44 @@
  *
  * @param aName         Name of the drive.
+ * @param aUdi          Universal device identifier (currently may be NULL).
  * @param aDescription  Human-readable drive description (may be NULL).
  *
@@ -101 +102 @@
 }
 
-/**
- * Returns a human readable description of the host drive
- *
- * @returns COM status code
- * @param driveDescription address of result pointer
- */
 STDMETHODIMP HostFloppyDrive::COMGETTER(Description) (BSTR *aDescription)
 {
@@ -122 +117 @@
 }
 
-/**
- * Returns the universal device identifier of the host drive
- *
- * @returns COM status code
- * @param driveDescription address of result pointer
- */
 STDMETHODIMP HostFloppyDrive::COMGETTER(Udi) (BSTR *aUdi)
 {
@@ -136 +125 @@
     CheckComRCReturnRC (autoCaller.rc());
 
-    /* mDescription is constant during life time, no need to lock */
+    /* mUdi is constant during life time, no need to lock */
 
     mUdi.cloneTo (aUdi);

trunk/src/VBox/Main/MachineImpl.cpp

@@ -1348 +1348 @@
 
     mSSData->mStateFilePath.cloneTo (aStateFilePath);
+
+    return S_OK;
+}
+
+STDMETHODIMP Machine::COMGETTER(LogFolder) (BSTR *aLogFolder)
+{
+    if (!aLogFolder)
+        return E_POINTER;
+
+    AutoCaller autoCaller (this);
+    AssertComRCReturnRC (autoCaller.rc());
+
+    AutoReaderLock alock (this);
+
+    Utf8Str logFolder;
+    getLogFolder (logFolder);
+
+    Bstr (logFolder).cloneTo (aLogFolder);
 
     return S_OK;
@@ -2470 +2488 @@
 {
     AutoCaller autoCaller (this);
-    AssertComRCReturn (autoCaller.rc(), (void) 0);
+    AssertComRCReturnVoid (autoCaller.rc());
 
     AutoReaderLock alock (this);
@@ -7665 +7683 @@
 
 /**
- *  @note Locks this object for reading.
- */
-STDMETHODIMP SessionMachine::GetLogFolder (BSTR *aLogFolder)
-{
-    AutoCaller autoCaller (this);
-    AssertComRCReturn (autoCaller.rc(), autoCaller.rc());
-
-    AutoReaderLock alock (this);
-
-    Utf8Str logFolder;
-    getLogFolder (logFolder);
-
-    Bstr (logFolder).cloneTo (aLogFolder);
-
-    return S_OK;
-}
-
-/**
  *  Goes through the USB filters of the given machine to see if the given
  *  device matches any filter or not.

trunk/src/VBox/Main/idl/VirtualBox.xidl

@@ -1600 +1600 @@
     <interface
         name="IInternalMachineControl" extends="$unknown"
-        uuid="F466BF2E-BD6B-4af0-9C08-46DD42B28A44"
+        uuid="e780b585-585d-47e2-ab53-e94dc552353c"
         internal="yes"
         wsmap="suppress"
@@ -1618 +1618 @@
         <method name="getIPCId">
             <param name="id" type="wstring" dir="return"/>
-        </method>
-
-        <method name="getLogFolder">
-            <desc>
-                Returns the full name of the directory where to store
-                log files created during this machine's executoin.
-            </desc>
-            <param name="logFolder" type="wstring" dir="return"/>
         </method>
 
@@ -1902 +1894 @@
     <interface
         name="IMachine" extends="$unknown"
-        uuid="063ad473-992d-479f-ba7e-7a9ae294368c"
+        uuid="0332de0e-ce75-461f-8c6f-0fa42616404a"
         wsmap="managed"
     >
@@ -2218 +2210 @@
         </attribute>
 
+        <attribute name="logFolder" type="wstring" readonly="yes">
+            <desc>
+                Full path to the folder that stores a set of rotated log files
+                recorded during machine execution. The most recent log file is
+                named <tt>VBox.log</tt>, the previous log file is
+                named <tt>VBox.log.1</tt> and so on (upto <tt>VBox.log.3</tt>
+                in the current version).
+            </desc>
+        </attribute>
+
         <attribute name="currentSnapshot" type="ISnapshot" readonly="yes">
             <desc>
@@ -3493 +3495 @@
     <interface
         name="IHostDVDDrive" extends="$unknown"
-        uuid="c2308775-85f3-45ab-ade5-97f02d1e61e0"
+        uuid="21f86694-202d-4ce4-8b05-a63ff82dbf4c"
         wsmap="managed"
     >
         <attribute name="name" type="wstring" readonly="yes">
-            <desc>Returns the platform device identifier.</desc>
+            <desc>
+                Returns the platform-specific device identifier.
+                On DOS-like platforms, it is a drive name (e.g. R:).
+                On Unix-like platforms, it is a device name (e.g. /dev/hdc).
+            </desc>
         </attribute>
         <attribute name="description" type="wstring" readonly="yes">
-            <desc>Returns a human readable description for the drive.</desc>
+            <desc>
+                Returns a human readable description for the drive.  This
+                description usually contains the product and vendor name.  A
+                @c null string is returned if the description is not available.
+            </desc>
         </attribute>
         <attribute name="udi" type="wstring" readonly="yes">
-            <desc>Returns the unique device identifier for the drive.</desc>
+            <desc>
+                Returns the unique device identifier for the drive.  This
+                attribute is reserved for future use instead of
+                <link to="#name"/>. Currently it is not used and may return
+                @c null on some platforms.
+            </desc>
         </attribute>
 
@@ -3538 +3553 @@
     <interface
         name="IHostFloppyDrive" extends="$unknown"
-        uuid="2b2ad1ab-2ea9-4cf8-be3c-2a76677d8725"
+        uuid="b6a4d1a9-4221-43c3-bd52-021a5daa9ed2"
         wsmap="managed"
     >
         <attribute name="name" type="wstring" readonly="yes">
-            <desc>Returns the platform device identifier.</desc>
+            <desc>
+                Returns the platform-specific device identifier.
+                On DOS-like platforms, it is a drive name (e.g. A:).
+                On Unix-like platforms, it is a device name (e.g. /dev/fd0).
+            </desc>
         </attribute>
         <attribute name="description" type="wstring" readonly="yes">
-            <desc>Returns a human readable description for the drive.</desc>
+            <desc>
+                Returns a human readable description for the drive.  This
+                description usually contains the product and vendor name.  A
+                @c null string is returned if the description is not available.
+            </desc>
         </attribute>
         <attribute name="udi" type="wstring" readonly="yes">
-            <desc>Returns the unique device identifier for the drive.</desc>
+            <desc>
+                Returns the unique device identifier for the drive.  This
+                attribute is reserved for future use instead of
+                <link to="#name"/>. Currently it is not used and may return
+                @c null on some platforms.
+            </desc>
         </attribute>
     </interface>

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

@@ -53 +53 @@
 
     // public initializer/uninitializer for internal purposes only
-    HRESULT init (INPTR BSTR aName, INPTR BSTR aUdi = NULL, INPTR BSTR aDescription = NULL);
+    HRESULT init (INPTR BSTR aName, INPTR BSTR aUdi = NULL,
+                  INPTR BSTR aDescription = NULL);
     void uninit();
 
@@ -65 +66 @@
     /* @note Must be called from under the object read lock. */
     const Bstr &name() const { return mName; }
+
+    /* @note Must be called from under the object read lock. */
     const Bstr &udi() const { return mUdi; }
+
+    /* @note Must be called from under the object read lock. */
     const Bstr &description() const { return mDescription; }
 

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

@@ -53 +53 @@
 
     // public initializer/uninitializer for internal purposes only
-    HRESULT init (INPTR BSTR aName, INPTR BSTR aUdi = NULL, INPTR BSTR aDescription = NULL);
+    HRESULT init (INPTR BSTR aName, INPTR BSTR aUdi = NULL,
+                  INPTR BSTR aDescription = NULL);
     void uninit();
 
@@ -65 +66 @@
     /* @note Must be called from under the object read lock. */
     const Bstr &name() const { return mName; }
+
+    /* @note Must be called from under the object read lock. */
     const Bstr &udi() const { return mUdi; }
+
+    /* @note Must be called from under the object read lock. */
     const Bstr &description() const { return mDescription; }
 

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

@@ -436 +436 @@
     STDMETHOD(COMGETTER(LastStateChange))(LONG64 *aLastStateChange);
     STDMETHOD(COMGETTER(StateFilePath)) (BSTR *aStateFilePath);
+    STDMETHOD(COMGETTER(LogFolder)) (BSTR *aLogFolder);
     STDMETHOD(COMGETTER(CurrentSnapshot)) (ISnapshot **aCurrentSnapshot);
     STDMETHOD(COMGETTER(SnapshotCount)) (ULONG *aSnapshotCount);
@@ -725 +726 @@
     STDMETHOD(UpdateState)(MachineState_T machineState);
     STDMETHOD(GetIPCId)(BSTR *id);
-    STDMETHOD(GetLogFolder) (BSTR *aLogFolder);
     STDMETHOD(RunUSBDeviceFilters) (IUSBDevice *aUSBDevice, BOOL *aMatched);
     STDMETHOD(CaptureUSBDevice) (INPTR GUIDPARAM aId, IUSBDevice **aHostDevice);