Changeset 37244 in vbox

Timestamp:

May 30, 2011 8:28:07 AM (14 years ago)

Author:

vboxsync

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

71966

Message:

Main/VirtualBox: new method for querying the API version

Location:

trunk

Files:

• Config.kmk (modified) (3 diffs)
• src/VBox/Frontends/VBoxManage/VBoxManageList.cpp (modified) (2 diffs)
• src/VBox/Main/idl/VirtualBox.xidl (modified) (2 diffs)
• src/VBox/Main/include/VirtualBoxImpl.h (modified) (3 diffs)
• src/VBox/Main/src-server/VirtualBoxImpl.cpp (modified) (4 diffs)

trunk/Config.kmk

@@ -1060 +1060 @@
 # Changed with every new version, so beware!
 if $(VBOX_VERSION_BUILD) < 51
-  VBOX_API_SUFFIX              = _$(VBOX_VERSION_MAJOR)_$(VBOX_VERSION_MINOR)
+  VBOX_API_VERSION          = $(VBOX_VERSION_MAJOR)_$(VBOX_VERSION_MINOR)
 else
-  VBOX_API_SUFFIX              = _$(VBOX_VERSION_MAJOR)_$(expr $(VBOX_VERSION_MINOR) + 1)
-endif
-VBOX_JAVA_PACKAGE             = org.virtualbox$(VBOX_API_SUFFIX)
+  VBOX_API_VERSION          = $(VBOX_VERSION_MAJOR)_$(expr $(VBOX_VERSION_MINOR) + 1)
+endif
+VBOX_API_SUFFIX             = _$(VBOX_API_VERSION)
+VBOX_JAVA_PACKAGE           = org.virtualbox$(VBOX_API_SUFFIX)
 
 #
@@ -4638 +4639 @@
 #
 VBOX_BAD_CHAR_SET   = ,;:/\$(SP)$(TAB)$(HASH)=![]@%&''()*""<>?^{}|~
-VBOX_VERSION_STAMP  = $(PATH_OUT)/version-stamp-raw-$(translate $(VBOX_VERSION_STRING)-$(VBOX_C_YEAR)-$(VBOX_VENDOR)-$(VBOX_PRODUCT),$(VBOX_BAD_CHAR_SET),,_)
+VBOX_VERSION_STAMP  = $(PATH_OUT)/version-stamp-raw-api-$(translate $(VBOX_VERSION_STRING)-$(VBOX_C_YEAR)-$(VBOX_VENDOR)-$(VBOX_PRODUCT)-$(VBOX_API_VERSION),$(VBOX_BAD_CHAR_SET),,_)
 VBOX_VERSION_HEADER = $(PATH_OUT)/version-generated.h
 VBOX_VERSION_MK     = $(PATH_OUT)/version-generated.mk
@@ -4660 +4661 @@
         $(QUIET)$(APPEND) [email protected] '#define VBOX_VERSION_STRING_RAW "$(VBOX_VERSION_STRING_RAW)"'
         $(QUIET)$(APPEND) [email protected] '#define VBOX_VERSION_STRING "$(VBOX_VERSION_STRING)"'
+        $(QUIET)$(APPEND) [email protected] '#define VBOX_API_VERSION_STRING "$(VBOX_API_VERSION)"'
         $(QUIET)$(APPEND) [email protected] ''
         $(QUIET)$(APPEND) [email protected] '#endif'

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

@@ -5 +5 @@
 
 /*
- * Copyright (C) 2006-2010 Oracle Corporation
+ * Copyright (C) 2006-2011 Oracle Corporation
  *
  * This file is part of VirtualBox Open Source Edition (OSE), as
@@ -832 +832 @@
             ULONG ulValue;
             LONG64 i64Value;
+
+            rptrVirtualBox->COMGETTER(APIVersion)(str.asOutParam());
+            RTPrintf("API version:                     %ls\n", str.raw());
 
             systemProperties->COMGETTER(MinGuestRAM)(&ulValue);

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

@@ -1392 +1392 @@
   <interface
     name="IVirtualBox" extends="$unknown"
-    uuid="d2de270c-1d4b-4c9e-843f-bbb9b47269ff"
+    uuid="bc166b9b-9b62-4145-b1f6-6c39068aaf00"
     wsmap="managed"
     >
@@ -1431 +1431 @@
         is either GENERIC, UBUNTU_606, UBUNTU_710, or something like
         this.
+      </desc>
+    </attribute>
+
+    <attribute name="APIVersion" type="wstring" readonly="yes">
+      <desc>
+        A string representing the VirtualBox API version number. The format is
+        2 integer numbers divided by an underscore (e.g. 1_0). After the
+        first public release of packages with a particular API version the
+        API will not be changed in an incompatible way. Note that this
+        guarantee does not apply to development builds, and also there is no
+        guarantee that this version is identical to the first two integer
+        numbers of the package version.
       </desc>
     </attribute>

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

@@ -5 +5 @@
 
 /*
- * Copyright (C) 2006-2010 Oracle Corporation
+ * Copyright (C) 2006-2011 Oracle Corporation
  *
  * This file is part of VirtualBox Open Source Edition (OSE), as
@@ -104 +104 @@
     STDMETHOD(COMGETTER(Revision))              (ULONG *aRevision);
     STDMETHOD(COMGETTER(PackageType))           (BSTR *aPackageType);
+    STDMETHOD(COMGETTER(APIVersion))            (BSTR *aAPIVersion);
     STDMETHOD(COMGETTER(HomeFolder))            (BSTR *aHomeFolder);
     STDMETHOD(COMGETTER(SettingsFilePath))      (BSTR *aSettingsFilePath);
@@ -313 +314 @@
     static ULONG sRevision;
     static Bstr sPackageType;
+    static Bstr sAPIVersion;
 
     static DECLCALLBACK(int) ClientWatcher (RTTHREAD thread, void *pvUser);

trunk/src/VBox/Main/src-server/VirtualBoxImpl.cpp

@@ -6 +6 @@
 
 /*
- * Copyright (C) 2006-2010 Oracle Corporation
+ * Copyright (C) 2006-2011 Oracle Corporation
  *
  * This file is part of VirtualBox Open Source Edition (OSE), as
@@ -104 +104 @@
 Bstr VirtualBox::sPackageType;
 
+// static
+Bstr VirtualBox::sAPIVersion;
+
 ////////////////////////////////////////////////////////////////////////////////
 //
@@ -390 +393 @@
     if (sPackageType.isEmpty())
         sPackageType = VBOX_PACKAGE_STRING;
-    LogFlowThisFunc(("Version: %ls, Package: %ls\n", sVersion.raw(), sPackageType.raw()));
+    if (sAPIVersion.isEmpty())
+        sAPIVersion = VBOX_API_VERSION_STRING;
+    LogFlowThisFunc(("Version: %ls, Package: %ls, API Version: %ls\n", sVersion.raw(), sPackageType.raw(), sAPIVersion.raw()));
 
     /* Get the VirtualBox home directory. */
@@ -885 +890 @@
 
     sPackageType.cloneTo(aPackageType);
+    return S_OK;
+}
+
+STDMETHODIMP VirtualBox::COMGETTER(APIVersion)(BSTR *aAPIVersion)
+{
+    CheckComArgNotNull(aAPIVersion);
+
+    AutoCaller autoCaller(this);
+    if (FAILED(autoCaller.rc())) return autoCaller.rc();
+
+    sAPIVersion.cloneTo(aAPIVersion);
     return S_OK;
 }