Changeset 36:29e3b676c0c2 in xplra

Timestamp:

02/10/13 08:21:47 (11 years ago)

Author:

István Váradi <ivaradi@…>

Branch:

default

Phase:

public

Message:

Added a new command to query the versions

Files:

• src/client/c/hu/varadiistvan/xplra/XPlane.cc (modified) (1 diff)
• src/client/c/hu/varadiistvan/xplra/XPlane.h (modified) (1 diff)
• src/client/c/hu/varadiistvan/xplra/xplra.cc (modified) (1 diff)
• src/client/c/hu/varadiistvan/xplra/xplra.h (modified) (1 diff)
• src/client/python/xplra.py (modified) (3 diffs)
• src/plugin/src/xplra/ListenThread.cc (modified) (1 diff)
• src/plugin/src/xplra/ListenThread.h (modified) (3 diffs)
• src/plugin/src/xplra/Protocol.h (modified) (2 diffs)
• src/plugin/src/xplra/ServerThread.cc (modified) (4 diffs)
• src/plugin/src/xplra/ServerThread.h (modified) (4 diffs)
• src/plugin/src/xplra/plugin.cc (modified) (1 diff)
• test/basicctest.c (modified) (2 diffs)
• test/basictest.cc (modified) (1 diff)
• test/basictest.py (modified) (1 diff)

src/client/c/hu/varadiistvan/xplra/XPlane.cc

@@ -193 +193 @@
 //------------------------------------------------------------------------------
 
+void XPlane::getVersions(int& xplaneVersion, int& xplmVersion, int& xplraVersion)
+    throw(Exception)
+{
+    stream->writeU8(Protocol::COMMAND_GET_VERSIONS);
+    stream->flush();
+    checkResult();
+
+    xplaneVersion = stream->readS32();
+    xplmVersion = stream->readS32();
+    xplraVersion = stream->readS32();
+
+    checkStream();
+}
+
+//------------------------------------------------------------------------------
+
 void XPlane::getScalar(const char* name, uint8_t type) throw(Exception)
 {

src/client/c/hu/varadiistvan/xplra/XPlane.h

@@ -145 +145 @@
 
     /**
+     * Get the versions of X-Plane, XPLM and the XPLRA plugin.
+     */
+    void getVersions(int& xplaneVersion, int& xplmVersion, int& xplraVersion) throw(Exception);
+
+    /**
      * Get the integer value of the dataref with the given name.
      */

src/client/c/hu/varadiistvan/xplra/xplra.cc

@@ -498 +498 @@
 //------------------------------------------------------------------------------
 
+extern "C"int xplra_get_versions(int connectionID,
+                                 int* xplaneVersion, int* xplmVersion,
+                                 int* xplraVersion)
+{
+    Connection* connection = ConnectionSlot::getValue(connectionID);
+    if (connection==0) return -1;
+    try {
+        connection->getVersions(*xplaneVersion, *xplmVersion, *xplraVersion);
+        return 0;
+    } catch (...) {
+        connection->handleException();
+        return -1;
+    }
+}
+
+//------------------------------------------------------------------------------
+
 extern "C" int xplra_get_int(int* value, int connectionID, const char* name)
 {

src/client/c/hu/varadiistvan/xplra/xplra.h

@@ -130 +130 @@
 
 /*----------------------------------------------------------------------------*/
+
+/**
+ * Get the versions of X-Plane, the XPLM library and XPLRA
+ */
+int xplra_get_versions(int connectionID,
+                       int* xplaneVersion, int* xplmVersion,
+                       int* xplraVersion);
+
+/*----------------------------------------------------------------------------*/
 /* Single dataref support                                                     */
 /*----------------------------------------------------------------------------*/

src/client/python/xplra.py

@@ -27 +27 @@
 
 COMMAND_EXECUTE_SET_MULTI = 0x23
+
+COMMAND_GET_VERSIONS = 0x31
 
 TYPE_INT = 0x01
@@ -135 +137 @@
         """Create a new multi-dataref setter for this X-Plane object."""
         return MultiSetter(self)
+
+    def getVersions(self):
+        """Get the versions of X-Plane, XPLM and XPLRA as a tuple."""
+        self._writeU8(COMMAND_GET_VERSIONS)
+        self._flush()
+        self._checkResult()
+        return (self._readS32(), self._readS32(), self._readS32())
 
     def getInt(self, name):
@@ -392 +401 @@
 
         self._registeredID = None
+
+    @property
+    def values(self):
+        """Query the values as a list."""
+        if self._values is None:
+            self.finalize()
+        return self._values
 
     def addInt(self, name):

src/plugin/src/xplra/ListenThread.cc

@@ -55 +55 @@
     while(!quitEvent.check() && !quitEvent.failed() && !acceptor.failed()) {
         if (acceptor.accept()) {
-            ServerThread* serverThread = new ServerThread(requestQueue,
+            ServerThread* serverThread = new ServerThread(*this,
+                                                          requestQueue,
                                                           acceptor);
             serverThread->start();

src/plugin/src/xplra/ListenThread.h

@@ -54 +54 @@
 private:
     /**
+     * The version of X-Plane.
+     */
+    int xplaneVersion;
+
+    /**
+     * The version of the XPLM library.
+     */
+    int xplmVersion;
+
+    /**
      * The waiter used in the thread.
      */
@@ -73 +83 @@
      * Construct the thread.
      */
-    ListenThread();
+    ListenThread(int xplaneVersion, int xplmVersion);
+
+    /**
+     * Get the versions
+     */
+    void getVersions(int& xplane, int& xplm) const;
 
     /**
@@ -90 +105 @@
 //------------------------------------------------------------------------------
 
-inline ListenThread::ListenThread() :
+inline ListenThread::ListenThread(int xplaneVersion, int xplmVersion) :
     Thread(true),
+    xplaneVersion(xplaneVersion),
+    xplmVersion(xplmVersion),
     quitEvent(&waiter)
 {
+}
+
+//------------------------------------------------------------------------------
+
+inline void ListenThread::getVersions(int& xplane, int& xplm) const
+{
+    xplane = xplaneVersion;
+    xplm = xplmVersion;
 }
 

src/plugin/src/xplra/Protocol.h

@@ -92 +92 @@
 
     /**
+     * Command: get the versions of the simulator
+     */
+    static const uint8_t COMMAND_GET_VERSIONS = 0x31;
+
+    /**
      * Data type: int
      */
@@ -176 +181 @@
      */
     static const size_t MAX_MULTI_COUNT = 1024;
+
+    /**
+     * The version of the plugin.
+     */
+    static const int version = 10;
 };
 

src/plugin/src/xplra/ServerThread.cc

@@ -31 +31 @@
 #include "ServerThread.h"
 
+#include "ListenThread.h"
 #include "RequestQueue.h"
 #include "Protocol.h"
@@ -72 +73 @@
 //------------------------------------------------------------------------------
 
-ServerThread::ServerThread(RequestQueue& requestQueue, LocalAcceptor& acceptor) :
+ServerThread::ServerThread(ListenThread& listenThread,
+                           RequestQueue& requestQueue, LocalAcceptor& acceptor) :
     Thread(true),
+    listenThread(listenThread),
     requestQueue(requestQueue),
     bufferedStream(acceptor.getSocket(&waiter)),
@@ -147 +150 @@
         } else if (command==Protocol::COMMAND_EXECUTE_SET_MULTI) {
             if (!handleExecuteSetMulti()) break;
+        } else if (command==Protocol::COMMAND_GET_VERSIONS) {
+            if (!handleGetVersions()) break;
         } else {
             stream.writeU8(Protocol::RESULT_INVALID_COMMAND);
@@ -384 +389 @@
 //------------------------------------------------------------------------------
 
+bool ServerThread::handleGetVersions()
+{
+    int xplaneVersion = 0;
+    int xplmVersion = 0;
+
+    listenThread.getVersions(xplaneVersion, xplmVersion);
+
+    stream.writeU8(Protocol::RESULT_OK);
+    stream.writeS32(xplaneVersion);
+    stream.writeS32(xplmVersion);
+    stream.writeS32(Protocol::version);
+
+    return true;
+}
+
+//------------------------------------------------------------------------------
+
 // Local Variables:
 // mode: C++

src/plugin/src/xplra/ServerThread.h

@@ -49 +49 @@
 //------------------------------------------------------------------------------
 
+class ListenThread;
+
 class RequestQueue;
 
@@ -95 +97 @@
 private:
     /**
+     * The listen thread this server was started by.
+     */
+    ListenThread& listenThread;
+
+    /**
      * The request queue to use.
      */
@@ -139 +146 @@
      * given acceptor.
      */
-    ServerThread(RequestQueue& requestQueue,
+    ServerThread(ListenThread& listenThread, RequestQueue& requestQueue,
                  hu::varadiistvan::scpl::io::LocalAcceptor& acceptor);
 
@@ -227 +234 @@
      */
     bool handleExecuteSetMulti();
+
+    /**
+     * Handle the COMMAND_GET_VERSIONS command
+     *
+     * @return true, if we can continue, false if the thread should quit
+     */
+    bool handleGetVersions();
 };
 

src/plugin/src/xplra/plugin.cc

@@ -83 +83 @@
     Util::debug("hu.varadiistvan.xplra.XPluginEnable called\n");
     // XPLMRegisterFlightLoopCallback(&callback, 5.0, 0);
-    listenThread = new ListenThread();
+
+    int xplaneVersion = 0;
+    int xplmVersion = 0;
+    XPLMHostApplicationID hostID = 0;
+    XPLMGetVersions(&xplaneVersion, &xplmVersion, &hostID);
+
+    listenThread = new ListenThread(xplaneVersion, xplmVersion);
     listenThread->start();
 }

test/basicctest.c

@@ -42 +42 @@
     int retval = 0;
     const char* errorString = 0;
+
+    int xplaneVersion = 0;
+    int xplmVersion = 0;
+    int xplraVersion = 0;
+
     int numEngines = 0;
     float spoolTime = 0.0;
@@ -69 +74 @@
     }
 
+    printf("Querying the versions...\n");
+    if (xplra_get_versions(connectionID, &xplaneVersion,
+                           &xplmVersion, &xplraVersion)<0) goto error;
+    printf("X-Plane version: %d, XPLM: %d, XPLRA: %03d\n\n",
+           xplaneVersion, xplmVersion, xplraVersion);
+
     printf("Querying the number of the engines...\n");
     if (xplra_get_int(&numEngines, connectionID,

test/basictest.cc

@@ -53 +53 @@
         printf("Connected to X-Plane.\n\n");
 
+        int xplaneVersion = 0;
+        int xplmVersion = 0;
+        int xplraVersion = 0;
+
+        printf("Querying the versions...\n");
+        xplane.getVersions(xplaneVersion, xplmVersion, xplraVersion);
+        printf("X-Plane version: %d, XPLM: %d, XPLRA: %03d\n\n",
+               xplaneVersion, xplmVersion, xplraVersion);
+
         printf("Querying the number of the engines...\n");
         int numEngines = xplane.getInt("sim/aircraft/engine/acf_num_engines");

test/basictest.py

@@ -12 +12 @@
         xplane.connect()
         print "Connected to X-Plane."
+        print
+
+        print "Querying the versions..."
+        (xplaneVersion, xplmVersion, xplraVersion) = xplane.getVersions()
+        print "X-Plane version: %d, XPLM: %d, XPLRA: %03d" % \
+               (xplaneVersion, xplmVersion, xplraVersion)
         print