I3IPC

Types and functions for interacting with i3's IPC mechanism

Subscribe to events

Commonly, you just want to subscribe to a set of event types and do something with the response:

import qualified I3IPC.Subscribe               as Sub
import           I3IPC.Event
import           I3IPC                          ( subscribe )
import           Control.Monad.IO.Class 

main :: IO ()
main = liftIO $ subscribe handle [Sub.Workspace, Sub.Window]
 where
  handle :: Either String Event -> IO ()
  handle (Right evt) = case evt of
    Workspace WorkspaceEvent { wrk_current } -> print wrk_current
    Window WindowEvent { win_container } -> print win_container
    _ -> error "No other event types"
  handle (Left err) = error err

Sending messages

Other times, you want to send some kind of command to i3, or get a specific response as a one-time action.

import           I3IPC              ( connecti3
                                    , getWorkspaces
                                    )
import           Control.Monad.IO.Class 

main :: IO ()
main = do
    soc <- liftIO $ connecti3
    print getWorkspaces

Convenience functions

All of the "getX" functions are provided for convenience, but also exported are the building blocks to write whatever you like. There are strict and non-strict variants provided, the tick (') implies strict. For instance, the above could be written as:

import qualified I3IPC.Message     as Msg
import           I3IPC              ( connecti3
                                    , receiveMsg
                                    )
import           Control.Monad.IO.Class 

main :: IO ()
main = do
    soc <- liftIO $ connecti3
    print $ Msg.sendMsg soc Msg.Workspaces >> receiveMsg soc

getSocketPath :: MonadIO m => m (Maybe ByteString)

Get a new unix socket path from i3

getSwaySocketPath :: MonadIO m => m (Maybe ByteString)

Get a new unix socket path from sway

data Response

Useful for when you are receiving Events or Messages.

Constructors

Message MsgReply

Event Event

Instances

Eq Response

Defined in I3IPC

Methods

(==) :: Response -> Response -> Bool

(/=) :: Response -> Response -> Bool

Show Response

Defined in I3IPC

Methods

showsPrec :: Int -> Response -> ShowS

show :: Response -> String

showList :: [Response] -> ShowS

subscribe :: (MonadThrow m, MonadIO m) => (Either String Event -> m ()) -> [Subscribe] -> m ()

Subscribe with a list of Subscribe types, and subscribe will to respond with specific Event

subscribeM :: (MonadThrow m, MonadIO m) => (Either String Event -> m ()) -> [Subscribe] -> m ()

A version of subscribe that allows the use of any monad transformer on top of MonadIO (kept around for backwards compatibility)

receive :: MonadIO m => Socket -> m (Either String Response)

Parse response from socket, returning either an error or a Response, representing a sum type of a MsgReply or Event

receive' :: MonadIO m => Socket -> m (Either String Response)

Like receive but strict-- will use eitherDecode' under the hood to parse

receiveMsg :: MonadIO m => Socket -> m (Either String MsgReply)

Receive but specifically for msgs, for when you know the response won't include any Events

receiveMsg' :: MonadIO m => Socket -> m (Either String MsgReply)

Like receiveMsg but strict-- uses eitherDecode'

getReply :: MonadIO m => Socket -> m (Either String (Int, ByteString))

Get and parse the response using i3's IPC

connecti3 :: (MonadThrow m, MonadIO m) => m Socket

Connect to an i3 socket and return it

connectsway :: (MonadThrow m, MonadIO m) => m Socket

Connect to SWAY socket and return it

receiveEvent :: MonadIO m => Socket -> m (Either String Event)

receive specifically for Event

receiveEvent' :: MonadIO m => Socket -> m (Either String Event)

like receiveEvent but strict-- uses eitherDecode'

runCommand :: MonadIO m => Socket -> ByteString -> m (Either String MsgReply)

Run a command represented as a ByteString, all the following functions are convenience wrappers around

Msg.sendMsgPayload soc Msg.X b >> receiveMsg soc

Or, if there is no message body:

Msg.sendMsg soc Msg.X >> receiveMsg soc

runCommand' :: MonadIO m => Socket -> ByteString -> m (Either String MsgReply)

getWorkspaces :: MonadIO m => Socket -> m (Either String MsgReply)

getWorkspaces' :: MonadIO m => Socket -> m (Either String MsgReply)

getOutputs :: MonadIO m => Socket -> m (Either String MsgReply)

getOutputs' :: MonadIO m => Socket -> m (Either String MsgReply)

getTree :: MonadIO m => Socket -> m (Either String MsgReply)

getTree' :: MonadIO m => Socket -> m (Either String MsgReply)

getMarks :: MonadIO m => Socket -> m (Either String MsgReply)

getMarks' :: MonadIO m => Socket -> m (Either String MsgReply)

getVersion :: MonadIO m => Socket -> m (Either String MsgReply)

getVersion' :: MonadIO m => Socket -> m (Either String MsgReply)

getBarConfig :: MonadIO m => Socket -> ByteString -> m (Either String MsgReply)

Get a bar's config based on it's id

getBarConfig' :: MonadIO m => Socket -> ByteString -> m (Either String MsgReply)

Like getBarConfig but strict

getBarIds :: MonadIO m => Socket -> m (Either String BarIds)

getBindingModes :: MonadIO m => Socket -> m (Either String MsgReply)

getBindingModes' :: MonadIO m => Socket -> m (Either String MsgReply)

getConfig :: MonadIO m => Socket -> m (Either String MsgReply)

getConfig' :: MonadIO m => Socket -> m (Either String MsgReply)

getTick :: MonadIO m => Socket -> m (Either String MsgReply)

getTick' :: MonadIO m => Socket -> m (Either String MsgReply)

getSync :: MonadIO m => Socket -> m (Either String MsgReply)

getSync' :: MonadIO m => Socket -> m (Either String MsgReply)