Merge lp:~dandrader/ubuntu-keyboard/fix_lp1234600 into lp:ubuntu-keyboard

[Daniel d'Andrada]

Publish keyboard info on a socket so that unity-mir can have it

Have a communication channel between ubuntu-keyboard and unity-mir where
the former hands out all the information about itself that unity-mir might
be interested into.

That all should go away once a proper architecure gets implemented.

Fixes LP#1234600.

Not thoroughly tested.

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:66
http://jenkins.qa.ubuntu.com/job/ubuntu-keyboard-ci/143/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-keyboard-saucy-amd64-ci/144
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-keyboard-saucy-armhf-ci/143
        deb: http://jenkins.qa.ubuntu.com/job/ubuntu-keyboard-saucy-armhf-ci/143/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-keyboard-saucy-i386-ci/143

Click here to trigger a rebuild:
http://10.97.0.26:8080/job/ubuntu-keyboard-ci/143/rebuild

review: Approve (continuous-integration)

[Michał Sawicz (saviq)]

Wow that's low level ;D But it works :)

review: Approve

[Thomas Voß (thomas-voss)]

LGTM, although we should refactor the overall osk/im setup asap.

review: Approve

=== modified file 'src/plugin/ubuntuapplicationapiwrapper.cpp'
--- src/plugin/ubuntuapplicationapiwrapper.cpp	2013-08-29 11:23:23 +0000
+++ src/plugin/ubuntuapplicationapiwrapper.cpp	2013-10-09 16:58:20 +0000
@@ -28,12 +28,27 @@
 #include <QtGlobal>
 #include <QByteArray>
 
+namespace {
+    const char gServerName[] = "ubuntu-keyboard-info";
+}
+
 UbuntuApplicationApiWrapper::UbuntuApplicationApiWrapper()
-    : m_runningOnMir(false)
+    : m_runningOnMir(false),
+      m_clientConnection(0)
 {
     if (qgetenv("QT_QPA_PLATFORM") == "ubuntumirclient") {
         m_runningOnMir = true;
     }
+
+    if (m_runningOnMir) {
+        connect(&m_localServer, &QLocalServer::newConnection,
+                this, &UbuntuApplicationApiWrapper::onNewConnection);
+        bool ok = m_localServer.listen(gServerName);
+        if (!ok) {
+            qWarning() << "UbuntuApplicationApiWrapper: failed to listen for connections on"
+                       << gServerName;
+        }
+    }
 }
 
 void UbuntuApplicationApiWrapper::reportOSKVisible(const int x, const int y, const int width, const int height)
@@ -48,6 +63,8 @@
     Q_UNUSED(width)
     Q_UNUSED(height)
 #endif
+
+    sendInfoToClientConnection(width, height);
 }
 
 void UbuntuApplicationApiWrapper::reportOSKInvisible()
@@ -68,3 +85,55 @@
 #endif
 }
 
+void UbuntuApplicationApiWrapper::sendInfoToClientConnection(int width, int height)
+{
+    if (!m_clientConnection
+            || m_clientConnection->state() != QLocalSocket::ConnectedState) {
+        // can't do it
+        return;
+    }
+
+    struct SharedInfo sharedInfo;
+    sharedInfo.keyboardWidth = width;
+    sharedInfo.keyboardHeight = height;
+    const qint64 sharedInfoSize = sizeof(struct SharedInfo);
+    qint64 bytesWritten = m_clientConnection->write(reinterpret_cast<char *>(&sharedInfo),
+                                                    sharedInfoSize);
+
+    if (bytesWritten < 0) {
+        qWarning("UbuntuApplicationApiWrapper: Failed to write bytes on client connection");
+    } else if (bytesWritten != sharedInfoSize) {
+        // Could try sending the remaining bytes until completion but it's really unlikely that
+        // this situation will occur
+        qWarning() << "UbuntuApplicationApiWrapper: tried to write" << sharedInfoSize << "bytes"
+                      "but only" << bytesWritten << "went through";
+    }
+}
+
+void UbuntuApplicationApiWrapper::onNewConnection()
+{
+    if (m_clientConnection)
+        return; // ignore it. for simplicity we care to serve only one client (unity8-mir)
+
+    m_clientConnection = m_localServer.nextPendingConnection();
+    connect(m_clientConnection, &QLocalSocket::disconnected,
+            this, &UbuntuApplicationApiWrapper::onClientDisconnected);
+
+    typedef void (QLocalSocket::*MemberFunctionType)(QLocalSocket::LocalSocketError);
+    MemberFunctionType funcPointer = &QLocalSocket::error;
+    connect(m_clientConnection, funcPointer,
+            this, &UbuntuApplicationApiWrapper::onClientError);
+}
+
+void UbuntuApplicationApiWrapper::onClientDisconnected()
+{
+    delete m_clientConnection;
+    m_clientConnection = 0;
+}
+
+void UbuntuApplicationApiWrapper::onClientError(QLocalSocket::LocalSocketError socketError)
+{
+    Q_UNUSED(socketError);
+    delete m_clientConnection;
+    m_clientConnection = 0;
+}

=== modified file 'src/plugin/ubuntuapplicationapiwrapper.h'
--- src/plugin/ubuntuapplicationapiwrapper.h	2013-08-23 12:11:19 +0000
+++ src/plugin/ubuntuapplicationapiwrapper.h	2013-10-09 16:58:20 +0000
@@ -17,6 +17,10 @@
 #ifndef UBUNTUAPPLICATIONAPIWRAPPER_H
 #define UBUNTUAPPLICATIONAPIWRAPPER_H
 
+#include <QObject>
+#include <QLocalServer>
+#include <QLocalSocket>
+
 /*
  * Class: UbuntuApplicationApiWrapper
  * The OSK-related functions in the ubuntu application api are marked as deprecated.
@@ -24,12 +28,11 @@
  * we are running on: if SurfaceFlinger-based, call the deprecated API, else NOOP.
  *
  * Have added other little methods to help smooth the transition.
- *
- * Once we discard the SurfaceFlinger-base, much of this can be removed.
  */
 
-class UbuntuApplicationApiWrapper
+class UbuntuApplicationApiWrapper : public QObject
 {
+    Q_OBJECT
 public:
     UbuntuApplicationApiWrapper();
 
@@ -38,8 +41,23 @@
     void reportOSKVisible(const int, const int, const int, const int);
     void reportOSKInvisible();
 
+private Q_SLOTS:
+    void onNewConnection();
+    void onClientDisconnected();
+    void onClientError(QLocalSocket::LocalSocketError socketError);
+
 private:
+    // NB! Must match the definition in unity-mir. Not worth creating a shared header
+    // just for that.
+    struct SharedInfo {
+        qint32 keyboardWidth;
+        qint32 keyboardHeight;
+    };
+    void sendInfoToClientConnection(int width, int height);
+
     bool m_runningOnMir;
+    QLocalServer m_localServer;
+    QLocalSocket *m_clientConnection;
 };
 
 #endif // UBUNTUAPPLICATIONAPIWRAPPER_H