i3/ipc: expose subscribe method to receive arbitrary events

Author: 3akev

src/x11/i3/ipc/connection.cpp

@@ -85,7 +85,7 @@ I3Ipc::I3Ipc() {
 	QObject::connect(&this->liveEventSocket, &QLocalSocket::errorOccurred, this, &I3Ipc::eventSocketError);
 	QObject::connect(&this->liveEventSocket, &QLocalSocket::stateChanged, this, &I3Ipc::eventSocketStateChanged);
 	QObject::connect(&this->liveEventSocket, &QLocalSocket::readyRead, this, &I3Ipc::eventSocketReady);
-	QObject::connect(&this->liveEventSocket, &QLocalSocket::connected, this, &I3Ipc::subscribe);
+	QObject::connect(&this->liveEventSocket, &QLocalSocket::connected, this, &I3Ipc::eventSocketConnected);
 	// clang-format on
 
 	this->liveEventSocketDs.setDevice(&this->liveEventSocket);
@@ -94,18 +94,23 @@ I3Ipc::I3Ipc() {
 	this->liveEventSocket.connectToServer(this->mSocketPath);
 }
 
-void I3Ipc::subscribe() {
+void I3Ipc::eventSocketConnected() {
 	auto payload = QByteArray(R"(["workspace","output"])");
-	auto message = I3Ipc::buildRequestMessage(EventCode::Subscribe, payload);
-
-	this->makeRequest(message);
+	this->subscribeEvent(payload);
 
 	// Workspaces must be refreshed before monitors or no focus will be
 	// detected on launch.
 	this->refreshWorkspaces();
 	this->refreshMonitors();
 }
 
+void I3Ipc::subscribe(const QString& payload) { this->subscribeEvent(payload.toLocal8Bit()); }
+
+void I3Ipc::subscribeEvent(const QByteArray& payload) {
+	auto message = I3Ipc::buildRequestMessage(EventCode::Subscribe, payload);
+	this->makeRequest(message);
+}
+
 void I3Ipc::eventSocketReady() {
 	for (auto& [type, data]: this->parseResponse()) {
 		this->event.mCode = type;

src/x11/i3/ipc/connection.hpp

@@ -85,6 +85,7 @@ class I3Ipc: public QObject {
 
 	void makeRequest(const QByteArray& request);
 	void dispatch(const QString& payload);
+	void subscribe(const QString& payload);
 
 	static QByteArray buildRequestMessage(EventCode cmd, const QByteArray& payload = QByteArray());
 
@@ -120,7 +121,7 @@ private slots:
 	void eventSocketError(QLocalSocket::LocalSocketError error) const;
 	void eventSocketStateChanged(QLocalSocket::LocalSocketState state);
 	void eventSocketReady();
-	void subscribe();
+	void eventSocketConnected();
 
 	void onFocusedMonitorDestroyed();
 
@@ -135,6 +136,8 @@ private slots:
 	static void handleRunCommand(I3IpcEvent* event);
 	static bool compareWorkspaces(I3Workspace* a, I3Workspace* b);
 
+	void subscribeEvent(const QByteArray& payload);
+
 	void reconnectIPC();
 
 	QVector<std::tuple<EventCode, QJsonDocument>> parseResponse();

src/x11/i3/ipc/qml.cpp

@@ -23,6 +23,7 @@ I3IpcQml::I3IpcQml() {
 }
 
 void I3IpcQml::dispatch(const QString& request) { I3Ipc::instance()->dispatch(request); }
+void I3IpcQml::subscribe(const QString& request) { I3Ipc::instance()->subscribe(request); }
 void I3IpcQml::refreshMonitors() { I3Ipc::instance()->refreshMonitors(); }
 void I3IpcQml::refreshWorkspaces() { I3Ipc::instance()->refreshWorkspaces(); }
 QString I3IpcQml::socketPath() { return I3Ipc::instance()->socketPath(); }

src/x11/i3/ipc/qml.hpp

@@ -35,6 +35,9 @@ class I3IpcQml: public QObject {
 	/// Execute an [I3/Sway command](https://i3wm.org/docs/userguide.html#list_of_commands)
 	Q_INVOKABLE static void dispatch(const QString& request);
 
+	/// Subscribe to an I3/Sway event, allows reception of subscribed events through rawEvent
+	Q_INVOKABLE static void subscribe(const QString& request);
+
 	/// Refresh monitor information.
 	Q_INVOKABLE static void refreshMonitors();