Changeset 18177 in vbox for trunk/src

Timestamp:

Mar 24, 2009 1:21:12 PM (16 years ago)

Author:

vboxsync

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

44892

Message:

Main: turn read/write param in OpenHardDisk into an enum

Location:

trunk/src/VBox

Files:

• Frontends/VBoxManage/VBoxInternalManage.cpp (modified) (1 diff)
• Frontends/VBoxManage/VBoxManageDisk.cpp (modified) (4 diffs)
• Frontends/VBoxManage/VBoxManageModifyVM.cpp (modified) (5 diffs)
• Frontends/VBoxSDL/VBoxSDL.cpp (modified) (1 diff)
• Frontends/VirtualBox/src/VBoxMediaManagerDlg.cpp (modified) (1 diff)
• Main/ApplianceImpl.cpp (modified) (1 diff)
• Main/VirtualBoxImpl.cpp (modified) (2 diffs)
• Main/idl/VirtualBox.xidl (modified) (3 diffs)
• Main/include/HardDiskImpl.h (modified) (1 diff)
• Main/include/VirtualBoxImpl.h (modified) (1 diff)
• Main/testcase/tstAPI.cpp (modified) (1 diff)

trunk/src/VBox/Frontends/VBoxManage/VBoxInternalManage.cpp

@@ -1263 +1263 @@
     {
         ComPtr<IHardDisk> hardDisk;
-        CHECK_ERROR(aVirtualBox, OpenHardDisk(filename, TRUE /* fWrite */, hardDisk.asOutParam()));
+        CHECK_ERROR(aVirtualBox, OpenHardDisk(filename, AccessMode_ReadWrite, hardDisk.asOutParam()));
     }
 

trunk/src/VBox/Frontends/VBoxManage/VBoxManageDisk.cpp

@@ -388 +388 @@
         if (!hardDisk)
         {
-            a->virtualBox->OpenHardDisk(Bstr(a->argv[0]), hardDisk.asOutParam());
+            a->virtualBox->OpenHardDisk(Bstr(a->argv[0]), AccessMode_ReadWrite, hardDisk.asOutParam());
             if (!hardDisk)
                 return errorArgument("Hard disk image not found");
@@ -521 +521 @@
         if (FAILED (rc))
         {
-            CHECK_ERROR(a->virtualBox, OpenHardDisk(src, TRUE /* fWrite */, srcDisk.asOutParam()));
+            CHECK_ERROR(a->virtualBox, OpenHardDisk(src, AccessMode_ReadWrite, srcDisk.asOutParam()));
             if (SUCCEEDED (rc))
             {
@@ -943 +943 @@
         if (FAILED (rc))
         {
-            CHECK_ERROR(a->virtualBox, OpenHardDisk(filepath, TRUE /* fWrite */, hardDisk.asOutParam()));
+            CHECK_ERROR(a->virtualBox, OpenHardDisk(filepath, AccessMode_ReadWrite, hardDisk.asOutParam()));
             if (SUCCEEDED (rc))
             {
@@ -1083 +1083 @@
 
         ComPtr<IHardDisk> hardDisk;
-        CHECK_ERROR(a->virtualBox, OpenHardDisk(filepath, TRUE /* fWrite */, hardDisk.asOutParam()));
+        CHECK_ERROR(a->virtualBox, OpenHardDisk(filepath, AccessMode_ReadWrite, hardDisk.asOutParam()));
         if (SUCCEEDED(rc) && hardDisk)
         {

trunk/src/VBox/Frontends/VBoxManage/VBoxManageModifyVM.cpp

@@ -1054 +1054 @@
                     {
                         /* open the new hard disk object */
-                        CHECK_ERROR(a->virtualBox, OpenHardDisk(Bstr(hdds[0]), TRUE /* fWrite */, hardDisk.asOutParam()));
+                        CHECK_ERROR(a->virtualBox, OpenHardDisk(Bstr(hdds[0]), AccessMode_ReadWrite, hardDisk.asOutParam()));
                     }
                 }
@@ -1087 +1087 @@
                     {
                         /* open the new hard disk object */
-                        CHECK_ERROR(a->virtualBox, OpenHardDisk(Bstr(hdds[1]), TRUE /* fWrite */, hardDisk.asOutParam()));
+                        CHECK_ERROR(a->virtualBox, OpenHardDisk(Bstr(hdds[1]), AccessMode_ReadWrite, hardDisk.asOutParam()));
                     }
                 }
@@ -1120 +1120 @@
                     {
                         /* open the new hard disk object */
-                        CHECK_ERROR(a->virtualBox, OpenHardDisk(Bstr(hdds[2]), TRUE /* fWrite */, hardDisk.asOutParam()));
+                        CHECK_ERROR(a->virtualBox, OpenHardDisk(Bstr(hdds[2]), AccessMode_ReadWrite, hardDisk.asOutParam()));
                     }
                 }
@@ -1833 +1833 @@
                         {
                             /* open the new hard disk object */
-                            CHECK_ERROR(a->virtualBox, OpenHardDisk(Bstr(hdds[i]), TRUE /* fWrite */, hardDisk.asOutParam()));
+                            CHECK_ERROR(a->virtualBox, OpenHardDisk(Bstr(hdds[i]), AccessMode_ReadWrite, hardDisk.asOutParam()));
                         }
                     }
@@ -1922 +1922 @@
                         {
                             /* open the new hard disk object */
-                            CHECK_ERROR(a->virtualBox, OpenHardDisk(Bstr(hdds[i]), TRUE /* fWrite */, hardDisk.asOutParam()));
+                            CHECK_ERROR(a->virtualBox, OpenHardDisk(Bstr(hdds[i]), AccessMode_ReadWrite, hardDisk.asOutParam()));
                         }
                     }

trunk/src/VBox/Frontends/VBoxSDL/VBoxSDL.cpp

@@ -1670 +1670 @@
             /* we've not found the image */
             RTPrintf("Adding hard disk '%S'...\n", hdaFile);
-            virtualBox->OpenHardDisk(hdaFileBstr, TRUE /* fWrite */, hardDisk.asOutParam());
+            virtualBox->OpenHardDisk(hdaFileBstr, AccessMode_ReadWrite, hardDisk.asOutParam());
         }
         /* do we have the right image now? */

trunk/src/VBox/Frontends/VirtualBox/src/VBoxMediaManagerDlg.cpp

@@ -1545 +1545 @@
         case VBoxDefs::MediaType_HardDisk:
         {
-            CHardDisk hd = mVBox.OpenHardDisk(aLocation, TRUE /* fWrite */);
+            CHardDisk hd = mVBox.OpenHardDisk(aLocation, KAccessMode_ReadWrite);
             if (mVBox.isOk())
             {

trunk/src/VBox/Main/ApplianceImpl.cpp

@@ -2312 +2312 @@
                             /* First open the existing disk image */
                             rc = pVirtualBox->OpenHardDisk(Bstr(strSrcFilePath),
-                                                           FALSE,           // read-only
+                                                           AccessMode_ReadOnly,
                                                            srcHdVBox.asOutParam());
                             if (FAILED(rc)) throw rc;

trunk/src/VBox/Main/VirtualBoxImpl.cpp

@@ -1133 +1133 @@
 }
 
-STDMETHODIMP VirtualBox::OpenHardDisk(IN_BSTR aLocation, BOOL fWrite, IHardDisk **aHardDisk)
+STDMETHODIMP VirtualBox::OpenHardDisk(IN_BSTR aLocation,
+                                      AccessMode_T accessMode,
+                                      IHardDisk **aHardDisk)
 {
     CheckComArgNotNull(aLocation);
@@ -1149 +1151 @@
     rc = hardDisk->init(this,
                         aLocation,
-                        (fWrite) ? HardDisk::OpenReadWrite : HardDisk::OpenReadOnly );
+                        (accessMode == AccessMode_ReadWrite) ? HardDisk::OpenReadWrite : HardDisk::OpenReadOnly );
 
     if (SUCCEEDED (rc))

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

@@ -360 +360 @@
 
   <enum
+       name="AccessMode"
+       uuid="1da0007c-ddf7-4be8-bcac-d84a1558785f"
+       >
+      <desc>
+          Access mode for opening files.
+      </desc>
+
+      <const name="ReadOnly"   value="1"/>
+      <const name="ReadWrite"  value="2"/>
+  </enum>
+
+  <enum
     name="MachineState"
     uuid="73bf04d0-7c4f-4684-9abf-d65a9ad74343"
@@ -1874 +1886 @@
         by reading hard disk data at the specified location.
 
-        If @a write is true, the image is opened for read/write access and must
-        have according permissions, as VirtualBox may actually write status
-        information into the disk's metadata sections. Note that write access
-        is required for all typical image usage in VirtualBox, since VirtualBox
-        may need to write metadata such as a UUID into the image. The only
-        exception is opening a source image temporarily for copying and
+        If @a write is ReadWrite (which it should be), the image is opened for
+        read/write access and must have according permissions, as VirtualBox
+        may actually write status information into the disk's metadata sections.
+
+        Note that write access is required for all typical image usage in VirtualBox,
+        since VirtualBox may need to write metadata such as a UUID into the image.
+        The only exception is opening a source image temporarily for copying and
         cloning when the image will quickly be closed again.
 
@@ -1903 +1916 @@
         </desc>
       </param>
-      <param name="write" type="boolean" dir="in">
+      <param name="accessMode" type="AccessMode" dir="in">
           <desc>
-              If true, opens for read/write access. If false, opens for read access only.
+              Determines whether to open the image in read/write or read-only mode.
           </desc>
       </param>

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

@@ -78 +78 @@
 
     enum HDDOpenMode  { OpenReadWrite, OpenReadOnly };
-                // have to use a special enum or otherwise the overloaded init() is ambiguous
+                // have to use a special enum for the overloaded init() below;
+                // can't use AccessMode_T from XIDL because that's mapped to an int
+                // and would be ambiguous
 
     // public initializer/uninitializer for internal purposes only

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

@@ -151 +151 @@
     STDMETHOD(CreateHardDisk)(IN_BSTR aFormat, IN_BSTR aLocation,
                                IHardDisk **aHardDisk);
-    STDMETHOD(OpenHardDisk) (IN_BSTR aLocation, BOOL fWrite, IHardDisk **aHardDisk);
+    STDMETHOD(OpenHardDisk) (IN_BSTR aLocation, AccessMode_T accessMode, IHardDisk **aHardDisk);
     STDMETHOD(GetHardDisk) (IN_GUID aId, IHardDisk **aHardDisk);
     STDMETHOD(FindHardDisk) (IN_BSTR aLocation, IHardDisk **aHardDisk);

trunk/src/VBox/Main/testcase/tstAPI.cpp

@@ -562 +562 @@
         Bstr src = L"E:\\develop\\innotek\\images\\NewHardDisk.vdi";
         printf ("Opening the existing hard disk '%ls'...\n", src.raw());
-        CHECK_ERROR_BREAK (virtualBox, OpenHardDisk (src, hd.asOutParam()));
+        CHECK_ERROR_BREAK (virtualBox, OpenHardDisk (src, AccessMode_ReadWrite, hd.asOutParam()));
         printf ("Enter to continue...\n");
         getchar();