Changeset 38:128b9ced9779 in xplra

Timestamp:

02/14/13 16:02:05 (12 years ago)

Author:

István Váradi <ivaradi@…>

Branch:

default

Phase:

public

Message:

Added basic support for showing a message

Files:

• misc/client.py (modified) (1 diff)
• src/plugin/src/xplra/ListenThread.h (modified) (6 diffs)
• src/plugin/src/xplra/Makefile.am (modified) (3 diffs)
• src/plugin/src/xplra/MessageRequest.cc (added)
• src/plugin/src/xplra/MessageRequest.h (added)
• src/plugin/src/xplra/MessageWindow.cc (added)
• src/plugin/src/xplra/MessageWindow.h (added)
• src/plugin/src/xplra/Protocol.h (modified) (3 diffs)
• src/plugin/src/xplra/ServerThread.cc (modified) (3 diffs)
• src/plugin/src/xplra/ServerThread.h (modified) (1 diff)
• src/plugin/src/xplra/plugin.cc (modified) (4 diffs)

misc/client.py

@@ -415 +415 @@
             print >> sys.stderr, "Invalid dataref at #%d" % (index,)
         elif result!=0:
+            print >> sys.stderr, "Error code:", result
+
+    def do_show_message(self, args):
+        words = self._splitArgs(args)
+        if len(words)<2:
+            print >> sys.stderr, "Missing parameters"
+            return False
+
+        message = words[0]
+        duration = float(words[1])
+
+        self._writeU8(0x41)
+        self._writeString(message)
+        self._writeFloat(duration)
+        self._flush()
+
+        result = self._readU8()
+        if result!=0:
             print >> sys.stderr, "Error code:", result
 

src/plugin/src/xplra/ListenThread.h

@@ -44 +44 @@
 //------------------------------------------------------------------------------
 
+class MessageWindow;
+
+//------------------------------------------------------------------------------
+
 /**
  * The thread that listens to incoming connections and starts the
@@ -62 +66 @@
      */
     int xplmVersion;
+
+    /**
+     * The message window for showing messages.
+     */
+    MessageWindow& messageWindow;
 
     /**
@@ -83 +92 @@
      * Construct the thread.
      */
-    ListenThread(int xplaneVersion, int xplmVersion);
+    ListenThread(int xplaneVersion, int xplmVersion,
+                 MessageWindow& messageWindow);
 
     /**
@@ -89 +99 @@
      */
     void getVersions(int& xplane, int& xplm) const;
+
+    /**
+     * Get the message window.
+     */
+    MessageWindow& getMessageWindow();
 
     /**
@@ -105 +120 @@
 //------------------------------------------------------------------------------
 
-inline ListenThread::ListenThread(int xplaneVersion, int xplmVersion) :
+inline ListenThread::ListenThread(int xplaneVersion, int xplmVersion,
+                                  MessageWindow& messageWindow) :
     Thread(true),
     xplaneVersion(xplaneVersion),
     xplmVersion(xplmVersion),
+    messageWindow(messageWindow),
     quitEvent(&waiter)
 {
@@ -119 +136 @@
     xplane = xplaneVersion;
     xplm = xplmVersion;
+}
+
+//------------------------------------------------------------------------------
+
+inline MessageWindow& ListenThread::getMessageWindow()
+{
+    return messageWindow;
 }
 

src/plugin/src/xplra/Makefile.am

@@ -3 +3 @@
 AM_CXXFLAGS=$(VSCPL_CFLAGS) $(LIBXPLCOMMON_CFLAGS)
 
-AM_CPPFLAGS=-DXPLM210
+AM_CPPFLAGS=-DXPLM100
 
 SRCS= \
@@ -16 +16 @@
         MultiTaskRequest.cc             \
         GetMultiDataRefRequest.cc       \
-        SetMultiDataRefRequest.cc
+        SetMultiDataRefRequest.cc       \
+        MessageWindow.cc                \
+        MessageRequest.cc
 
 noinst_HEADERS= \
@@ -31 +33 @@
         MultiTaskRequest.h              \
         GetMultiDataRefRequest.h        \
-        SetMultiDataRefRequest.h
+        SetMultiDataRefRequest.h        \
+        MessageWindow.h                 \
+        MessageRequest.h
 
 if TARGET_API_POSIX

src/plugin/src/xplra/Protocol.h

@@ -97 +97 @@
 
     /**
+     * Command: show a message in the message window.
+     */
+    static const uint8_t COMMAND_SHOW_MESSAGE = 0x41;
+
+    /**
      * Data type: int
      */
@@ -165 +170 @@
      */
     static const uint8_t RESULT_INVALID_ID = 0x07;
+
+    /**
+     * Result code: invalid duration
+     */
+    static const uint8_t RESULT_INVALID_DURATION = 0x08;
 
     /**
@@ -181 +191 @@
      */
     static const size_t MAX_MULTI_COUNT = 1024;
+
+    /**
+     * The maximal message duration
+     */
+    static const float MAX_MESSAGE_DURATION = 5*60;
 
     /**

src/plugin/src/xplra/ServerThread.cc

@@ -39 +39 @@
 #include "GetMultiDataRefRequest.h"
 #include "SetMultiDataRefRequest.h"
+#include "MessageRequest.h"
 
 #include <hu/varadiistvan/xplcommon/Util.h>
@@ -152 +153 @@
         } else if (command==Protocol::COMMAND_GET_VERSIONS) {
             if (!handleGetVersions()) break;
+        } else if (command==Protocol::COMMAND_SHOW_MESSAGE) {
+            if (!handleShowMessage()) break;
         } else {
             stream.writeU8(Protocol::RESULT_INVALID_COMMAND);
@@ -400 +403 @@
     stream.writeS32(xplmVersion);
     stream.writeS32(Protocol::version);
+
+    return true;
+}
+
+//------------------------------------------------------------------------------
+
+bool ServerThread::handleShowMessage()
+{
+    string message = stream.readString();
+    float duration = stream.readFloat();
+    if (!stream) return false;
+
+    if (duration>Protocol::MAX_MESSAGE_DURATION) {
+        stream.writeU8(Protocol::RESULT_INVALID_DURATION);
+    } else {
+        MessageRequest request(listenThread.getMessageWindow(), message, duration);
+        if (!requestQueue.execute(&request)) return false;
+
+        stream.writeU8(Protocol::RESULT_OK);
+    }
 
     return true;

src/plugin/src/xplra/ServerThread.h

@@ -241 +241 @@
      */
     bool handleGetVersions();
+
+    /**
+     * Handle the COMMAND_SHOW_MESSAGE command
+     *
+     * @return true, if we can continue, false if the thread should quit
+     */
+    bool handleShowMessage();
 };
 

src/plugin/src/xplra/plugin.cc

@@ -31 +31 @@
 #include "ListenThread.h"
 
+#include "MessageWindow.h"
+
 #include <hu/varadiistvan/xplcommon/Util.h>
 #include <hu/varadiistvan/scpl/config.h>
@@ -49 +51 @@
 
 using xplra::ListenThread;
+using xplra::MessageWindow;
 
 using hu::varadiistvan::xplcommon::Util;
 
 //------------------------------------------------------------------------------
+
+/**
+ * The window to display messages from the clients.
+ */
+static MessageWindow* messageWindow = 0;
 
 /**
@@ -89 +97 @@
     XPLMGetVersions(&xplaneVersion, &xplmVersion, &hostID);
 
-    listenThread = new ListenThread(xplaneVersion, xplmVersion);
+    messageWindow = new MessageWindow();
+
+    listenThread = new ListenThread(xplaneVersion, xplmVersion,
+                                    *messageWindow);
     listenThread->start();
 }
@@ -108 +119 @@
     Util::debug("hu.varadiistvan.xplra.XPluginDisable called\n");
     // XPLMUnregisterFlightLoopCallback(&callback, 0);
+
     if (listenThread!=0) {
         listenThread->quit();
         listenThread = 0;
     }
+
+    delete messageWindow; messageWindow = 0;
 }