Qt bindings for i3wm's IPC interface. More...

#include <qi3pc.h>

Inheritance diagram for qi3pc:

Classes
struct	ParseError
	Container for the attributes of a parsing error from i3wm when trying to run an unparsable command. More...

Public Types
enum class	IpcEvent : quint32 { Workspace = I3_IPC_EVENT_WORKSPACE , Output = I3_IPC_EVENT_OUTPUT , Mode = I3_IPC_EVENT_MODE , Window = I3_IPC_EVENT_WINDOW , BarUpdate = I3_IPC_EVENT_BARCONFIG_UPDATE , Binding = I3_IPC_EVENT_BINDING , Shutdown = I3_IPC_EVENT_SHUTDOWN , Tick = I3_IPC_EVENT_TICK }
	Types of events offered by i3wm's IPC API. More...
enum class	IpcType : quint32 { Command = I3_IPC_REPLY_TYPE_COMMAND , Workspaces = I3_IPC_REPLY_TYPE_WORKSPACES , Subscribe = I3_IPC_REPLY_TYPE_SUBSCRIBE , Outputs = I3_IPC_REPLY_TYPE_OUTPUTS , Tree = I3_IPC_REPLY_TYPE_TREE , Marks = I3_IPC_REPLY_TYPE_MARKS , BarConfig = I3_IPC_REPLY_TYPE_BAR_CONFIG , Version = I3_IPC_REPLY_TYPE_VERSION , BindingModes = I3_IPC_REPLY_TYPE_BINDING_MODES , Config = I3_IPC_REPLY_TYPE_CONFIG , Tick = I3_IPC_REPLY_TYPE_TICK , Sync = I3_IPC_REPLY_TYPE_SYNC , BindingState = I3_IPC_REPLY_TYPE_GET_BINDING_STATE }
	Types of message/replies the API send/expect to/from i3wm. More...
enum class	WorkspaceChange { Empty , Focus , Init , Move , Reload , Rename , Restored , Urgent , Unknown }
	Types of change a workspace event can have. More...
enum class	OutputChange { Unspecified , Unknown }
	Types of change an output event can have. More...
enum class	WindowChange { New , Close , Focus , Title , Fullscreen , Move , Floating , Urgent , Mark , Unknown }
	Types of change a window event can have. More...
enum class	ShutdownChange { Restart , Exit , Unknown }
	Types of change a shutdown event can have. More...
enum class	BindingChange { Run , Unknown }
	Types of change a binding event can have. More...
using	DataObject = std::optional<std::pair<QJsonObject, qint64>>
	Optional pair of a JSON object with its last update time.
using	DataArray = std::optional<std::pair<QJsonArray, qint64>>
	Optional pair of a JSON array with its last update time.
using	DataString = std::optional<std::pair<QString, qint64>>
	Optional pair of a string with its last update time.
using	Error = std::optional<ParseError>
	Optional qi3pc::ParseError. The optional is empty when the error could not be parsed.
using	CommandResults = std::vector<std::pair<bool, Error>>
	Pairs of qi3pc::Error and boolean.
using	Message = std::optional<std::pair<QJsonDocument, quint32>>
	Optional pair of a JSON document with a qi3pc::IpcType received with a message or an event before it has been processed.

Public Slots
void	fetchWorkspaces ()
	Signal to emit to trigger an update of the list of workspace cache.
void	fetchTree ()
	Signal to emit to trigger an update of the (cached) layout tree.
void	fetchOutputs ()
	Signal to emit to trigger an update of the (cached) outputs.
void	fetchMarks ()
	Signal to emit to trigger an update of the (cached) list of marks.
void	fetchBarConfig (const QString &id)
	Signal to emit to update the (cached) configuration of a certain bar.
void	fetchBarConfigs ()
	Signal to emit to update the list of bar configurations.
void	fetchVersion ()
	Signal to emit to trigger a cache update for the i3wm version.
void	fetchBindingModes ()
	Signal to emit to trigger an update of the (cached) list of modes.
void	fetchConfig ()
	Signal to emit to trigger an update of the (cached) config.
void	fetchBindingState ()
	Request update of the (cached) binding state.

Signals
void	commandRan (qi3pc::CommandResults result)
	A command have been ran by i3.
void	tickSent (bool success)
	A tick message have been replied to by i3.
void	synced (bool success)
	A sync message have been replied to by i3.
void	subscribed (bool success)
	A subscribe message have been replied to.
void	workspaceEvent (qi3pc::WorkspaceChange change, const QJsonObject &current, const QJsonObject &old)
	The workspaces changed.
void	outputEvent (qi3pc::OutputChange change)
	Signal emitted when the output(s) change.
void	modeEvent (QString change, bool pango)
	The binding mode changes.
void	windowEvent (qi3pc::WindowChange change, const QJsonObject &container)
	A window changed.
void	barUpdateEvent (const QJsonObject &doc)
	A bar's configuration have been updated.
void	bindingEvent (qi3pc::BindingChange change, const QJsonObject &binding, const QString &mode)
	A binding have been triggered to run a command.
void	shutdownEvent (qi3pc::ShutdownChange change)
	The ipc socket is about to shutdown.
void	tickEvent (const QString &payload)
	A tick event is received from i3.
void	workspacesUpdated (const qi3pc::DataArray &workspaces)
	The (cached) list of workspaces have been updated.
void	treeUpdated (const qi3pc::DataObject &tree)
	The layout tree cache have been updated.
void	outputsUpdated (const qi3pc::DataArray &outputs)
	The (cached) outputs have been updated.
void	marksUpdated (const qi3pc::DataArray &marks)
	The (cached) list of marks have been updated.
void	barConfigUpdated (const QJsonObject &config)
	A specific bar's (cached) config have been updated. At this point the configuration for the bar has been cached.
void	newBarConfig (const QString &id)
	A new bar config have been added to the cache.
void	versionUpdated (const qi3pc::DataObject &version)
	The (cached) i3 version have been updated.
void	bindingModesUpdated (const qi3pc::DataArray &modes)
	The (cached) list of modes have been updated.
void	configUpdated (const qi3pc::DataObject &config)
	The (cached) config have been updated.
void	bindingStateUpdated (const qi3pc::DataString &state)
	The (cached) current binding state have been updated.

Public Member Functions
	qi3pc (QObject *parent=nullptr)
	Construct a qi3pc object.
	qi3pc (const QString &socketPath, QObject *parent=nullptr)
	Construct a qi3pc object connected to the provided socket.
virtual	~qi3pc ()
	Simple destructor for the qi3pc class.
bool	connect (int msecs=1500)
	Start listening to messages and events from the window manager.
bool	isConnected ()
	Check if the connection to the ipc socket is established.
bool	disconnect (int msecs=1500)
	Stop listening to messages and events from the window manager.
void	subscribe (const QStringList &events)
	Subscribe to a list of events.
QString	socketPath () const
	Get the socket path selected at construction.
template<IpcType Type>
void	sendMessage (const QByteArray &payload=QByteArray())
	Send a message with the specified type and payload to i3.
const DataArray &	workspaces () const
	Get the list of (cached) workspaces.
const DataObject &	tree () const
	Get the (cached) i3 layout tree.
const DataArray &	outputs () const
	Get the (cached) list of outputs.
const DataArray &	marks () const
	Get the (cached) list of set marks.
const DataObject &	barConfigs () const
	Get the (cached) list of all bar configurations.
const DataObject &	version () const
	Get the (cached) i3 version object.
const DataArray &	bindingModes () const
	Get the (cached) list of binding modes.
const DataObject &	config () const
	Get the (cached) data read from the config file.
const DataString &	bindingState () const
	Get the (cached) binding state.

Static Public Member Functions
static QString	FindSocketPath ()
	Find the path to the i3 ipc local unix socket.
static QString	FindSocketPathFromI3Binary ()
	Find the path to the i3 ipc local unix socket using the i3 binary.

Static Public Attributes
static constexpr auto	IpcMagicString = std::string("i3-ipc")
static constexpr auto	IpcMagicLength = IpcMagicString.length()

Private Member Functions
Message	processMessage (QLocalSocket &socket)
	Read one message using the socket parameter.
void	processEvent ()
	Read data from the event socket.
void	processReply ()
	Read data from the message socket.
void	processWorkspaceEvent (const QJsonDocument &doc)
	Handle data received from a workspace event.
void	processOutputEvent (const QJsonDocument &doc)
	Handle data received from an output event.
void	processModeEvent (const QJsonDocument &doc)
	Handle data received from a mode event.
void	processWindowEvent (const QJsonDocument &doc)
	Handle data received from a window event.
void	processBarUpdateEvent (const QJsonDocument &doc)
	Handle data received from a bar update event.
void	processBindingEvent (const QJsonDocument &doc)
	Handle data received from a binding event.
void	processShutdownEvent (const QJsonDocument &doc)
	Handle data received from a shutdowm event.
void	processTickEvent (const QJsonDocument &doc)
	Handle data received from a tick event.
void	processCommandReply (const QJsonDocument &doc)
	Handle data received from a run command reply.
void	processWorkspaceReply (const QJsonDocument &doc)
	Handle data received from a workspace reply.
void	processOutputReply (const QJsonDocument &doc)
	Handle data received from an output reply.
void	processTreeReply (const QJsonDocument &doc)
	Handle data received from a tree reply.
void	processMarkReply (const QJsonDocument &doc)
	Handle data received from a mark reply.
void	processBarConfigReply (const QJsonDocument &doc)
	Handle data received from a bar config reply.
void	processVersionReply (const QJsonDocument &doc)
	Handle data received from a version reply.
void	processBindingModesReply (const QJsonDocument &doc)
	Handle data received in a binding mode reply.
void	processConfigReply (const QJsonDocument &doc)
	Handle data received from a config reply.
void	processTickReply (const QJsonDocument &doc)
	Handle data received from a tick reply.
void	processSyncReply (const QJsonDocument &doc)
	Handle data received from a sync reply.
void	processBindingStateReply (const QJsonDocument &doc)
	Handle data received from a binding state event reply.

Static Private Member Functions
static WorkspaceChange	WorkspaceChangeFromString (const QString &s)
	Convert a string into a workspace change object.
static WindowChange	WindowChangeFromString (const QString &s)
	Convert a string into a window change object.
static ShutdownChange	ShutdownChangeFromString (const QString &s)
	Convert a string into a shutdown change object.
static OutputChange	OutputChangeFromString (const QString &s)
	Convert a string into an output change object.
static BindingChange	BindingChangeFromString (const QString &s)
	Convert a string into a binding change object.
static void	WritePayload (QLocalSocket &socket, const QByteArray &payload, IpcType type)
	Send a message with the specified type and payload to i3 using the specified socket.

Private Attributes
QString	m_socketPath
QLocalSocket	m_eventSocket
QLocalSocket	m_messageSocket
DataObject	m_tree
DataArray	m_workspaces
DataArray	m_outputs
DataArray	m_marks
DataObject	m_barConfigs
DataObject	m_version
DataArray	m_bindingModes
DataString	m_bindingState
DataObject	m_config

Detailed Description

Qt bindings for i3wm's IPC interface.

qi3pc is a modern C++20 library providing idiomatics Qt bindings to i3wm's IPC interface.

Definition at line 52 of file qi3pc.h.

Member Typedef Documentation

◆ DataObject

using qi3pc::DataObject = std::optional<std::pair<QJsonObject, qint64>>

Optional pair of a JSON object with its last update time.

Definition at line 187 of file qi3pc.h.

◆ DataArray

using qi3pc::DataArray = std::optional<std::pair<QJsonArray, qint64>>

Optional pair of a JSON array with its last update time.

Definition at line 190 of file qi3pc.h.

◆ DataString

using qi3pc::DataString = std::optional<std::pair<QString, qint64>>

Optional pair of a string with its last update time.

Definition at line 193 of file qi3pc.h.

◆ Error

using qi3pc::Error = std::optional<ParseError>

Optional qi3pc::ParseError. The optional is empty when the error could not be parsed.

Definition at line 262 of file qi3pc.h.

◆ CommandResults

using qi3pc::CommandResults = std::vector<std::pair<bool, Error>>

Pairs of qi3pc::Error and boolean.

For each element, if the boolean is false, the command was ran successfully. Otherwise information about the parse error encountered is in the second element.

Definition at line 270 of file qi3pc.h.

◆ Message

using qi3pc::Message = std::optional<std::pair<QJsonDocument, quint32>>

Optional pair of a JSON document with a qi3pc::IpcType received with a message or an event before it has been processed.

See also: qi3pc::IpcType; qi3pc::IpcEvent

Definition at line 278 of file qi3pc.h.

Member Enumeration Documentation

◆ IpcEvent

enum class qi3pc::IpcEvent : quint32

strong

Types of events offered by i3wm's IPC API.

See i3 docs.

Enumerator
Workspace	The workspace list changed The output list changed
Output	The mode changed
Mode	The windows changed
Window	The bar config changed
BarUpdate	A binding was ran
Binding	The IPC shutdown
Shutdown	A tick message was requested

Definition at line 66 of file qi3pc.h.

◆ IpcType

enum class qi3pc::IpcType : quint32

strong

Types of message/replies the API send/expect to/from i3wm.

See i3 docs.

Enumerator
Command	(Run) Command
Workspaces	Current workspaces
Subscribe	Subscription
Outputs	Current outputs
Tree	Tree layout
Marks	Current defined marks
BarConfig	Specific bar configuration
Version	i3 version
BindingModes	Configured binding modes
Config	Last loaded i3 config (raw)
Tick	Trigger a tick event
Sync	Trigger a sync protocol message
BindingState	Current binding state

Definition at line 92 of file qi3pc.h.

◆ WorkspaceChange

enum class qi3pc::WorkspaceChange

strong

Types of change a workspace event can have.

Mapping of the change property received in a workspace event.

Enumerator
Empty	A workspace became empty.
Focus	A workspace received input focus.
Init	A workspace was created.
Move	A workspace was moved to a different output.
Reload	The window manager's config was reloaded.
Rename	A workspace was renamed.
Restored	A workspace's layout was restored to a saved layout.
Urgent	A workspace gained/lost urgent status.
Unknown	Unsupported change.

Definition at line 116 of file qi3pc.h.

◆ OutputChange

enum class qi3pc::OutputChange

strong

Types of change an output event can have.

Mapping of the change property received in a output event.

Enumerator
Unspecified	See i3 docs.
Unknown	Unsupported change.

Definition at line 135 of file qi3pc.h.

◆ WindowChange

enum class qi3pc::WindowChange

strong

Types of change a window event can have.

Mapping of the change property received in a window event.

Enumerator
New	A new window is created.
Close	A window is closed.
Focus	A window gained focus.
Title	A window's title changed.
Fullscreen	A window entered/left fullscreen mode.
Move	A window have been moved.
Floating	A window entered/left floating mode.
Urgent	A window gained/lost urgent status.
Mark	A mark was added/remvoed to/from a window.
Unknown	Unsupported change.

Definition at line 147 of file qi3pc.h.

◆ ShutdownChange

enum class qi3pc::ShutdownChange

strong

Types of change a shutdown event can have.

Mapping of the change property received in a shutdown event.

Enumerator
Restart	The window mananger is restarted.
Exit	The window manager is exiting.
Unknown	Unsupported change.

Definition at line 167 of file qi3pc.h.

◆ BindingChange

enum class qi3pc::BindingChange

strong

Types of change a binding event can have.

Mapping of the change property received in a binding event.

Enumerator
Run	A binding was run.
Unknown	Unsupported change.

Definition at line 180 of file qi3pc.h.

Constructor & Destructor Documentation

◆ qi3pc() [1/2]

qi3pc::qi3pc ( QObject * parent = nullptr )

explicit

Construct a qi3pc object.

Parameters

parent Parent of the qi3pc object to create (matching Qt conventions).

Definition at line 28 of file qi3pc.cpp.

References qi3pc(), and FindSocketPath().

◆ qi3pc() [2/2]

qi3pc::qi3pc	(	const QString &	socketPath,
		QObject *	parent = nullptr )

explicit

Construct a qi3pc object connected to the provided socket.

Parameters

socketPath	The path to the server to use (e.g. /tmp/some-service.socket)
parent	Parent of the qi3pc object to create (matching Qt conventions).

Definition at line 32 of file qi3pc.cpp.

References m_barConfigs, m_eventSocket, m_messageSocket, m_socketPath, processEvent(), and processReply().

◆ ~qi3pc()

qi3pc::~qi3pc ( )

virtual

Simple destructor for the qi3pc class.

Disconnects the used sockets.

See also: qi3pc::disconnect

Definition at line 48 of file qi3pc.cpp.

References m_eventSocket, and m_messageSocket.

Member Function Documentation

◆ connect()

bool qi3pc::connect ( int msecs = 1500 )

Start listening to messages and events from the window manager.

Parameters

msecs A duration in milliseconds. This method may wait up to twice that duraction.

Returns: Whether the connection succeeded within the alloted time

This method may wait up to msecs milliseconds for the connection to be established. If it takes more than msecs milliseconds to connect, the connection might be established later, but the returned value will not reflect that.

See also: qi3pc::connected

Definition at line 602 of file qi3pc.cpp.

References m_eventSocket, m_messageSocket, and m_socketPath.

◆ isConnected()

bool qi3pc::isConnected ( )

Check if the connection to the ipc socket is established.

Returns: Return if the connection to the two sockets (message/events) were established.

See also: qi3pc::connect

Definition at line 643 of file qi3pc.cpp.

References m_eventSocket, and m_messageSocket.

◆ disconnect()

bool qi3pc::disconnect ( int msecs = 1500 )

Stop listening to messages and events from the window manager.

Parameters

msecs A duration in milliseconds. This method may wait up to twice that duraction.

Returns: Whether the connection succeeded within the alloted time

See also: qi3pc::isConnected

Definition at line 623 of file qi3pc.cpp.

References m_eventSocket, and m_messageSocket.

◆ subscribe()

void qi3pc::subscribe ( const QStringList & events )

Subscribe to a list of events.

Parameters

events A list of strings with the events to subscribe to.

Definition at line 656 of file qi3pc.cpp.

References m_eventSocket, Subscribe, and WritePayload().

◆ FindSocketPath()

QString qi3pc::FindSocketPath ( )

static

Find the path to the i3 ipc local unix socket.

First tries to read the I3SOCK environment variable. If I3SOCK is empty or not set, calls

i3 --get-socketpath

Returns: The path to the unix socket.

Definition at line 509 of file qi3pc.cpp.

References FindSocketPathFromI3Binary().

◆ FindSocketPathFromI3Binary()

QString qi3pc::FindSocketPathFromI3Binary ( )

static

Find the path to the i3 ipc local unix socket using the i3 binary.

Calls and returns the output of

i3 --get-socketpath

Returns: The path to the unix socket.

Definition at line 521 of file qi3pc.cpp.

◆ socketPath()

QString qi3pc::socketPath ( ) const

Get the socket path selected at construction.

Returns: The i3 socket path from when the object was created.

Definition at line 533 of file qi3pc.cpp.

References m_socketPath.

◆ sendMessage()

template<IpcType Type>

void qi3pc::sendMessage ( const QByteArray & payload = QByteArray() )

inline

Send a message with the specified type and payload to i3.

Template Parameters

Type	The type of the message to send.

Parameters

payload The content of the message.

Available message types.

Definition at line 375 of file qi3pc.h.

References m_eventSocket, m_messageSocket, Subscribe, Tick, and WritePayload().

◆ workspaces()

const qi3pc::DataArray & qi3pc::workspaces ( ) const

Get the list of (cached) workspaces.

Returns: The list of workspaces with its last update time.

See also: qi3pc::fetchWorkspaces

Definition at line 540 of file qi3pc.cpp.

References m_workspaces.

◆ tree()

const qi3pc::DataObject & qi3pc::tree ( ) const

Get the (cached) i3 layout tree.

Returns: The layout tree with its last update time

See also: qi3pc::fetchTree

Definition at line 547 of file qi3pc.cpp.

References m_tree.

◆ outputs()

const qi3pc::DataArray & qi3pc::outputs ( ) const

Get the (cached) list of outputs.

Returns: The list of outputs with its last update time.

See also: qi3pc::fetchOutputs

Definition at line 554 of file qi3pc.cpp.

References m_outputs.

◆ marks()

const qi3pc::DataArray & qi3pc::marks ( ) const

Get the (cached) list of set marks.

Returns: The list of marks and its last update time.

See also: qi3pc::fetchMarks

Definition at line 561 of file qi3pc.cpp.

References m_marks.

◆ barConfigs()

const qi3pc::DataObject & qi3pc::barConfigs ( ) const

Get the (cached) list of all bar configurations.

Returns: A map of bar configurations and its last update time.

See also: qi3pc::fetchBarConfig; qi3pc::barConfigUpdated; qi3pc::newBarConfig

Definition at line 568 of file qi3pc.cpp.

References m_barConfigs.

◆ version()

const qi3pc::DataObject & qi3pc::version ( ) const

Get the (cached) i3 version object.

Returns: The i3 version and the last time it was updated.

See also: qi3pc::fetchVersion; qi3pc::versionUpdated

Definition at line 575 of file qi3pc.cpp.

References m_version.

◆ bindingModes()

const qi3pc::DataArray & qi3pc::bindingModes ( ) const

Get the (cached) list of binding modes.

Returns: The list of binding modes and its last update time.

See also: qi3pc::fetchBindingModes; qi3pc::bindingModesUpdated

Definition at line 582 of file qi3pc.cpp.

References m_bindingModes.

◆ config()

const qi3pc::DataObject & qi3pc::config ( ) const

Get the (cached) data read from the config file.

Returns: The config and the last time it was updated.

See also: qi3pc::fetchConfig; qi3pc::configUpdated

Definition at line 589 of file qi3pc.cpp.

References m_config.

◆ bindingState()

const qi3pc::DataString & qi3pc::bindingState ( ) const

Get the (cached) binding state.

Returns: The binding state and the last time it was updated.

See also: qi3pc::fetchBindingState; qi3pc::bindingStateUpdated

Definition at line 596 of file qi3pc.cpp.

References m_bindingState.

◆ fetchWorkspaces

void qi3pc::fetchWorkspaces ( )

slot

Signal to emit to trigger an update of the list of workspace cache.

See also: qi3pc::workspaces; qi3pc::workspacesUpdated

Definition at line 690 of file qi3pc.cpp.

References sendMessage().

◆ fetchTree

void qi3pc::fetchTree ( )

slot

Signal to emit to trigger an update of the (cached) layout tree.

See also: qi3pc::tree; qi3pc::treeUpdated

Definition at line 696 of file qi3pc.cpp.

References sendMessage().

◆ fetchOutputs

void qi3pc::fetchOutputs ( )

slot

Signal to emit to trigger an update of the (cached) outputs.

See also: qi3pc::outputs; qi3pc::outputsUpdated

Definition at line 702 of file qi3pc.cpp.

References sendMessage().

◆ fetchMarks

void qi3pc::fetchMarks ( )

slot

Signal to emit to trigger an update of the (cached) list of marks.

See also: qi3pc::marks; qi3pc::marksUpdated

Definition at line 708 of file qi3pc.cpp.

References sendMessage().

◆ fetchBarConfig

void qi3pc::fetchBarConfig ( const QString & id )

slot

Signal to emit to update the (cached) configuration of a certain bar.

Parameters

id	String identifying to bar to update.

See also: qi3pc::barConfigUpdated; qi3pc::newBarConfig; qi3pc::barConfigs

Definition at line 738 of file qi3pc.cpp.

References sendMessage().

◆ fetchBarConfigs

void qi3pc::fetchBarConfigs ( )

slot

Signal to emit to update the list of bar configurations.

See also: qi3pc::barConfigUpdated; qi3pc::newBarConfig; qi3pc::barConfigs

Definition at line 732 of file qi3pc.cpp.

References sendMessage().

◆ fetchVersion

void qi3pc::fetchVersion ( )

slot

Signal to emit to trigger a cache update for the i3wm version.

See also: qi3pc::version; qi3pc::versionUpdated

Definition at line 714 of file qi3pc.cpp.

References sendMessage().

◆ fetchBindingModes

void qi3pc::fetchBindingModes ( )

slot

Signal to emit to trigger an update of the (cached) list of modes.

See also: qi3pc::bindingModes; qi3pc::bindingModesUpdated

Definition at line 720 of file qi3pc.cpp.

References sendMessage().

◆ fetchConfig

void qi3pc::fetchConfig ( )

slot

Signal to emit to trigger an update of the (cached) config.

See also: qi3pc::config; qi3pc::configUpdated

Definition at line 726 of file qi3pc.cpp.

References sendMessage().

◆ fetchBindingState

void qi3pc::fetchBindingState ( )

slot

Request update of the (cached) binding state.

See also: qi3pc::bindingState; qi3pc::bindingStateUpdated

Definition at line 746 of file qi3pc.cpp.

References sendMessage().

◆ processMessage()

qi3pc::Message qi3pc::processMessage ( QLocalSocket & socket )

private

Read one message using the socket parameter.

Parameters

socket Local unix socket from which the message is read

Returns: An optional json doc and the type of the message read

Definition at line 459 of file qi3pc.cpp.

References IpcMagicLength, and IpcMagicString.

◆ processEvent()

void qi3pc::processEvent ( )

private

Read data from the event socket.

Definition at line 58 of file qi3pc.cpp.

References BarUpdate, Binding, m_eventSocket, Mode, Output, processBarUpdateEvent(), processBindingEvent(), processMessage(), processModeEvent(), processOutputEvent(), processShutdownEvent(), processTickEvent(), processTickReply(), processWindowEvent(), processWorkspaceEvent(), Shutdown, Subscribe, subscribed(), Tick, Window, and Workspace.

◆ processReply()

void qi3pc::processReply ( )

private

Read data from the message socket.

Definition at line 116 of file qi3pc.cpp.

References BarConfig, BindingModes, BindingState, Command, Config, m_messageSocket, Marks, Outputs, processBarConfigReply(), processBindingModesReply(), processBindingStateReply(), processCommandReply(), processConfigReply(), processMarkReply(), processMessage(), processOutputReply(), processSyncReply(), processTreeReply(), processVersionReply(), processWorkspaceReply(), Subscribe, Sync, Tick, Tree, Version, and Workspaces.

◆ processWorkspaceEvent()

void qi3pc::processWorkspaceEvent ( const QJsonDocument & doc )

private

Handle data received from a workspace event.

Parameters

doc	Document containing the data

Definition at line 290 of file qi3pc.cpp.

References Unknown, WorkspaceChangeFromString(), and workspaceEvent().

◆ processOutputEvent()

void qi3pc::processOutputEvent ( const QJsonDocument & doc )

private

Handle data received from an output event.

Parameters

doc	Document containing the data

Definition at line 305 of file qi3pc.cpp.

References OutputChangeFromString(), outputEvent(), and Unknown.

◆ processModeEvent()

void qi3pc::processModeEvent ( const QJsonDocument & doc )

private

Handle data received from a mode event.

Parameters

doc	Document containing the data

Definition at line 318 of file qi3pc.cpp.

References modeEvent().

◆ processWindowEvent()

void qi3pc::processWindowEvent ( const QJsonDocument & doc )

private

Handle data received from a window event.

Parameters

doc	Document containing the data

Definition at line 324 of file qi3pc.cpp.

References Unknown, WindowChangeFromString(), and windowEvent().

◆ processBarUpdateEvent()

void qi3pc::processBarUpdateEvent ( const QJsonDocument & doc )

private

Handle data received from a bar update event.

Parameters

doc	Document containing the data

Definition at line 337 of file qi3pc.cpp.

References barUpdateEvent().

◆ processBindingEvent()

void qi3pc::processBindingEvent ( const QJsonDocument & doc )

private

Handle data received from a binding event.

Parameters

doc	Document containing the data

Definition at line 343 of file qi3pc.cpp.

References BindingChangeFromString(), bindingEvent(), and Unknown.

◆ processShutdownEvent()

void qi3pc::processShutdownEvent ( const QJsonDocument & doc )

private

Handle data received from a shutdowm event.

Parameters

doc	Document containing the data

Definition at line 356 of file qi3pc.cpp.

References ShutdownChangeFromString(), shutdownEvent(), and Unknown.

◆ processTickEvent()

void qi3pc::processTickEvent ( const QJsonDocument & doc )

private

Handle data received from a tick event.

Parameters

doc	Document containing the data

Definition at line 369 of file qi3pc.cpp.

References tickEvent().

◆ processCommandReply()

void qi3pc::processCommandReply ( const QJsonDocument & doc )

private

Handle data received from a run command reply.

Parameters

doc	Document containing the data

Definition at line 176 of file qi3pc.cpp.

References commandRan(), and qi3pc::ParseError::FromJSON().

◆ processWorkspaceReply()

void qi3pc::processWorkspaceReply ( const QJsonDocument & doc )

private

Handle data received from a workspace reply.

Parameters

doc	Document containing the data

Definition at line 203 of file qi3pc.cpp.

References m_workspaces, and workspacesUpdated().

◆ processOutputReply()

void qi3pc::processOutputReply ( const QJsonDocument & doc )

private

Handle data received from an output reply.

Parameters

doc	Document containing the data

Definition at line 210 of file qi3pc.cpp.

References m_outputs, and outputsUpdated().

◆ processTreeReply()

void qi3pc::processTreeReply ( const QJsonDocument & doc )

private

Handle data received from a tree reply.

Parameters

doc	Document containing the data

Definition at line 217 of file qi3pc.cpp.

References m_tree, and treeUpdated().

◆ processMarkReply()

void qi3pc::processMarkReply ( const QJsonDocument & doc )

private

Handle data received from a mark reply.

Parameters

doc	Document containing the data

Definition at line 224 of file qi3pc.cpp.

References m_marks, and marksUpdated().

◆ processBarConfigReply()

void qi3pc::processBarConfigReply ( const QJsonDocument & doc )

private

Handle data received from a bar config reply.

Parameters

doc	Document containing the data

Definition at line 231 of file qi3pc.cpp.

References barConfigUpdated(), config(), m_barConfigs, and newBarConfig().

◆ processVersionReply()

void qi3pc::processVersionReply ( const QJsonDocument & doc )

private

Handle data received from a version reply.

Parameters

doc	Document containing the data

Definition at line 250 of file qi3pc.cpp.

References m_version, and versionUpdated().

◆ processBindingModesReply()

void qi3pc::processBindingModesReply ( const QJsonDocument & doc )

private

Handle data received in a binding mode reply.

Parameters

doc	Document containing the data

Definition at line 257 of file qi3pc.cpp.

References bindingModesUpdated(), and m_bindingModes.

◆ processConfigReply()

void qi3pc::processConfigReply ( const QJsonDocument & doc )

private

Handle data received from a config reply.

Parameters

doc	Document containing the data

Definition at line 264 of file qi3pc.cpp.

References configUpdated(), and m_config.

◆ processTickReply()

void qi3pc::processTickReply ( const QJsonDocument & doc )

private

Handle data received from a tick reply.

Parameters

doc	Document containing the data

Definition at line 271 of file qi3pc.cpp.

References tickSent().

◆ processSyncReply()

void qi3pc::processSyncReply ( const QJsonDocument & doc )

private

Handle data received from a sync reply.

Parameters

doc	Document containing the data

Definition at line 277 of file qi3pc.cpp.

References synced().

◆ processBindingStateReply()

void qi3pc::processBindingStateReply ( const QJsonDocument & doc )

private

Handle data received from a binding state event reply.

Parameters

doc	Document containing the data

Definition at line 283 of file qi3pc.cpp.

References bindingStateUpdated(), and m_bindingState.

◆ WorkspaceChangeFromString()

qi3pc::WorkspaceChange qi3pc::WorkspaceChangeFromString ( const QString & s )

staticprivate

Convert a string into a workspace change object.

Parameters

s	The string to convert

Returns: A qi3pc::WorkspaceChange value.

Definition at line 377 of file qi3pc.cpp.

References Empty, Focus, Init, Move, Reload, Rename, Restored, Unknown, and Urgent.

◆ WindowChangeFromString()

qi3pc::WindowChange qi3pc::WindowChangeFromString ( const QString & s )

staticprivate

Convert a string into a window change object.

Parameters

s	The string to convert

Returns: A qi3pc::WindowChange value.

Definition at line 401 of file qi3pc.cpp.

References Close, Floating, Focus, Fullscreen, Mark, Move, New, Title, Unknown, and Urgent.

◆ ShutdownChangeFromString()

qi3pc::ShutdownChange qi3pc::ShutdownChangeFromString ( const QString & s )

staticprivate

Convert a string into a shutdown change object.

Parameters

s	The string to convert

Returns: A qi3pc::ShutdownChange value.

Definition at line 427 of file qi3pc.cpp.

References Exit, Restart, and Unknown.

◆ OutputChangeFromString()

qi3pc::OutputChange qi3pc::OutputChangeFromString ( const QString & s )

staticprivate

Convert a string into an output change object.

Parameters

s	The string to convert

Returns: A qi3pc::OutputChange value.

Definition at line 439 of file qi3pc.cpp.

References Unknown, and Unspecified.

◆ BindingChangeFromString()

qi3pc::BindingChange qi3pc::BindingChangeFromString ( const QString & s )

staticprivate

Convert a string into a binding change object.

Parameters

s	The string to convert

Returns: A qi3pc::BindingChange value.

Definition at line 449 of file qi3pc.cpp.

References Run, and Unknown.

◆ WritePayload()

void qi3pc::WritePayload	(	QLocalSocket &	socket,
		const QByteArray &	payload,
		IpcType	type )

staticprivate

Send a message with the specified type and payload to i3 using the specified socket.

Parameters

socket	The socket where the payload should be written.
payload	The content to be written on the socket.
type	The type of the payload.

Definition at line 671 of file qi3pc.cpp.

References IpcMagicLength, and IpcMagicString.

◆ commandRan

void qi3pc::commandRan ( qi3pc::CommandResults result )

signal

A command have been ran by i3.

Parameters

result Pairs of boolean and optional parse error.

Use qi3pc::sendMessage to run command with the qi3pc::IpcType::Command type.

◆ tickSent

void qi3pc::tickSent ( bool success )

signal

A tick message have been replied to by i3.

Parameters

success

Use qi3pc::sendMessage to send tick messages with the qi3pc::IpcType::Tick type.

◆ synced

void qi3pc::synced ( bool success )

signal

A sync message have been replied to by i3.

Parameters

success

Use qi3pc::sendMessage to send sync messages with the qi3pc::IpcTypeSync type.

◆ subscribed

void qi3pc::subscribed ( bool success )

signal

A subscribe message have been replied to.

Parameters

success Indicates whether the subscription was successfull

See also: qi3pc::subscribe

◆ workspaceEvent

void qi3pc::workspaceEvent	(	qi3pc::WorkspaceChange	change,
		const QJsonObject &	current,
		const QJsonObject &	old )

signal

The workspaces changed.

Parameters

change	The type of change
current	The current workspace
old	The old workspace

◆ outputEvent

void qi3pc::outputEvent ( qi3pc::OutputChange change )

signal

Signal emitted when the output(s) change.

Parameters

change The type of change

◆ modeEvent

void qi3pc::modeEvent	(	QString	change,
		bool	pango )

signal

The binding mode changes.

Parameters

change	The name of the current mode.
pango	Boolean telling whether to display the mode with pango markup.

◆ windowEvent

void qi3pc::windowEvent	(	qi3pc::WindowChange	change,
		const QJsonObject &	container )

signal

A window changed.

Parameters

change	The type of change.
container	The parent of the changed window.

◆ barUpdateEvent

void qi3pc::barUpdateEvent ( const QJsonObject & doc )

signal

A bar's configuration have been updated.

Parameters

doc	Json object containing the bar configuration.

◆ bindingEvent

void qi3pc::bindingEvent	(	qi3pc::BindingChange	change,
		const QJsonObject &	binding,
		const QString &	mode )

signal

A binding have been triggered to run a command.

Parameters

change	The type of change.
binding	The binding that was run.
mode	The name of the mode the binding was run in.

See also: qi3pc::bindingState

◆ shutdownEvent

void qi3pc::shutdownEvent ( qi3pc::ShutdownChange change )

signal

The ipc socket is about to shutdown.

Parameters

change The type of change.

◆ tickEvent

void qi3pc::tickEvent ( const QString & payload )

signal

A tick event is received from i3.

Parameters

payload Arbitrary payload sent with the tick message.

◆ workspacesUpdated

void qi3pc::workspacesUpdated ( const qi3pc::DataArray & workspaces )

signal

The (cached) list of workspaces have been updated.

Parameters

workspaces The last list of workspaces with the update time.

See also: qi3pc::fetchWorkspaces

References workspaces().

◆ treeUpdated

void qi3pc::treeUpdated ( const qi3pc::DataObject & tree )

signal

The layout tree cache have been updated.

Parameters

tree	The most recent layout tree cached and its update time.

See also: qi3pc::fetchTree

References tree().

◆ outputsUpdated

void qi3pc::outputsUpdated ( const qi3pc::DataArray & outputs )

signal

The (cached) outputs have been updated.

Parameters

outputs The latest list of outputs and its update time.

See also: qi3pc::fetchOutputs

References outputs().

◆ marksUpdated

void qi3pc::marksUpdated ( const qi3pc::DataArray & marks )

signal

The (cached) list of marks have been updated.

Parameters

marks The most recent list of marks and the time when it was updated.

See also: qi3pc::fetchMarks

References marks().

◆ barConfigUpdated

void qi3pc::barConfigUpdated ( const QJsonObject & config )

signal

A specific bar's (cached) config have been updated. At this point the configuration for the bar has been cached.

Parameters

config The relevant bar's configuration.

See also: qi3pc::barConfigs

References config().

◆ newBarConfig

void qi3pc::newBarConfig ( const QString & id )

signal

A new bar config have been added to the cache.

Parameters

id	The id of the new bar.

Only the id is stored at first. Call qi3pc::fetchBarConfig with the appropriate id to update it.

◆ versionUpdated

void qi3pc::versionUpdated ( const qi3pc::DataObject & version )

signal

The (cached) i3 version have been updated.

Parameters

version JSON object with the latest cached version and the time when it was updated.

See also: qi3pc::version

References version().

◆ bindingModesUpdated

void qi3pc::bindingModesUpdated ( const qi3pc::DataArray & modes )

signal

The (cached) list of modes have been updated.

Parameters

modes The most recent list of modes and the time when it was updated.

See also: qi3pc::modes

◆ configUpdated

void qi3pc::configUpdated ( const qi3pc::DataObject & config )

signal

The (cached) config have been updated.

Parameters

config The most recent config and the time when it was updated.

See also: qi3pc::config

References config().

◆ bindingStateUpdated

void qi3pc::bindingStateUpdated ( const qi3pc::DataString & state )

signal

The (cached) current binding state have been updated.

Parameters

state The most recent binding state and the time when it was updated.

See also: qi3pc::bindingState

Member Data Documentation

◆ IpcMagicString

auto qi3pc::IpcMagicString = std::string("i3-ipc")

staticconstexpr

Magic string used by the current API

Definition at line 57 of file qi3pc.h.

◆ IpcMagicLength

auto qi3pc::IpcMagicLength = IpcMagicString.length()

staticconstexpr

Length of the current magic string

Definition at line 58 of file qi3pc.h.

◆ m_socketPath

QString qi3pc::m_socketPath

private

Path of the local unix socket used.

Definition at line 731 of file qi3pc.h.

◆ m_eventSocket

QLocalSocket qi3pc::m_eventSocket

private

Socket used to subscribe and handle events.

Definition at line 733 of file qi3pc.h.

◆ m_messageSocket

QLocalSocket qi3pc::m_messageSocket

private

Socket used to send messages and handle replies.

Definition at line 734 of file qi3pc.h.

◆ m_tree

DataObject qi3pc::m_tree

private

Layout tree cache.

Definition at line 736 of file qi3pc.h.

◆ m_workspaces

DataArray qi3pc::m_workspaces

private

Workspace list cache.

Definition at line 737 of file qi3pc.h.

◆ m_outputs

DataArray qi3pc::m_outputs

private

Output list cache.

Definition at line 738 of file qi3pc.h.

◆ m_marks

DataArray qi3pc::m_marks

private

Mark list cache.

Definition at line 739 of file qi3pc.h.

◆ m_barConfigs

DataObject qi3pc::m_barConfigs

private

Bar configuration list cache.

Definition at line 740 of file qi3pc.h.

◆ m_version

DataObject qi3pc::m_version

private

Version cache.

Definition at line 741 of file qi3pc.h.

◆ m_bindingModes

DataArray qi3pc::m_bindingModes

private

Binding modes cache.

Definition at line 742 of file qi3pc.h.

◆ m_bindingState

DataString qi3pc::m_bindingState

private

Current binding mode cache.

Definition at line 743 of file qi3pc.h.

◆ m_config

DataObject qi3pc::m_config

private

Configuration cache.

Definition at line 744 of file qi3pc.h.

The documentation for this class was generated from the following files:

Classes

Public Types

Public Slots

Signals

Public Member Functions

Static Public Member Functions

Static Public Attributes

Private Member Functions

Static Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ DataObject

◆ DataArray

◆ DataString

◆ Error

◆ CommandResults

◆ Message

Member Enumeration Documentation

◆ IpcEvent

◆ IpcType

◆ WorkspaceChange

◆ OutputChange

◆ WindowChange

◆ ShutdownChange

◆ BindingChange

Constructor & Destructor Documentation

◆ qi3pc() [1/2]

◆ qi3pc() [2/2]

◆ ~qi3pc()

Member Function Documentation

◆ connect()

◆ isConnected()

◆ disconnect()

◆ subscribe()

◆ FindSocketPath()

◆ FindSocketPathFromI3Binary()

◆ socketPath()

◆ sendMessage()

◆ workspaces()

◆ tree()

◆ outputs()

◆ marks()

◆ barConfigs()

◆ version()

◆ bindingModes()

◆ config()

◆ bindingState()

◆ fetchWorkspaces

◆ fetchTree

◆ fetchOutputs

◆ fetchMarks

◆ fetchBarConfig

◆ fetchBarConfigs

◆ fetchVersion

◆ fetchBindingModes

◆ fetchConfig

◆ fetchBindingState

◆ processMessage()

◆ processEvent()

◆ processReply()

◆ processWorkspaceEvent()

◆ processOutputEvent()

◆ processModeEvent()

◆ processWindowEvent()

◆ processBarUpdateEvent()

◆ processBindingEvent()

◆ processShutdownEvent()

◆ processTickEvent()

◆ processCommandReply()

◆ processWorkspaceReply()

◆ processOutputReply()

◆ processTreeReply()

◆ processMarkReply()

◆ processBarConfigReply()

◆ processVersionReply()

◆ processBindingModesReply()

◆ processConfigReply()

◆ processTickReply()

◆ processSyncReply()