Helic

A clipboard management CLI tool built with Polysemy, Servant and GI.Gtk.

Documentation

Helic is primarily a CLI tool that listens for clipboard events and broadcasts them to other hosts and tmux.

The program is built with Polysemy, so its effects and interpreters may be useful for other developers. Some utilities for interfacing with GTK are exposed as well.

data Agent :: Effect

An agent is an interface to an external entity that can receive clipboard events. The Helic CLI uses agents for remote hosts over network, tmux, and X11.

data AgentTag

Used to disambiguate Agents via Tagged.

type Agents = [Tagged AgentTmux Agent, Tagged AgentX Agent, Tagged AgentNet Agent]

The default agents for the Helic CLI.

XClipboard

data XClipboard :: Effect

Communicate with the X11 clipboard.

Interpreters

interpretAgentNet :: Members [Manager, Reader NetConfig] r => Members [Log, Interrupt, Race, Resource, Async, Embed IO, Final IO] r => InterpreterFor (Tagged AgentNet Agent) r

Interpret Agent using remote hosts as targets. This also starts the HTTP server that listens to network events, which are used both for remote hosts and CLI events.

interpretAgentX :: Members [EventConsumer xr XClipboardEvent, Events er Event, Reader InstanceName, XClipboard, ChronosTime] r => Members [Events xr XClipboardEvent, Error Text, Race, Resource, Async, Embed IO, Final IO] r => InterpreterFor (Tagged AgentX Agent) r

Interpret Agent using the X11 clipboard as target. This interpreter also runs a thread that converts events generated by the XClipboard interpreter (XClipboardEvent) to the main Event type.

interpretAgentTmux :: Members [Reader TmuxConfig, Log, Async, Race, Resource, Embed IO] r => InterpreterFor (Tagged AgentTmux Agent) r

Interpret Agent using a tmux server as the target.

interpretXClipboardGtk :: Members [Reader GtkState, Log, Embed IO, Final IO] r => InterpreterFor XClipboard r

Interpret XClipboard using a GTK backend. This uses the gi-gtk library to access the X11 clipboard.

Data

data Event

The central data type representing a clipboard event.

Instances

Eq Event

Defined in Helic.Data.Event

Methods

(==) :: Event -> Event -> Bool

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

Show Event

Defined in Helic.Data.Event

Methods

showsPrec :: Int -> Event -> ShowS

show :: Event -> String

showList :: [Event] -> ShowS

ToJSON Event

Defined in Helic.Data.Event

Methods

toJSON :: Event -> Value

toEncoding :: Event -> Encoding

toJSONList :: [Event] -> Value

toEncodingList :: [Event] -> Encoding

FromJSON Event

Defined in Helic.Data.Event

Methods

parseJSON :: Value -> Parser Event

parseJSONList :: Value -> Parser [Event]

Utilities

transformXEvents :: Member (Reader InstanceName) r => Members [EventConsumer xr XClipboardEvent, Events er Event, XClipboard, ChronosTime, Resource, Race, Async] r => Sem r a -> Sem r a

Listen for XClipboardEvents and publish them as Events.

withMainLoop :: Members [Log, Error Text, Race, Async, Resource, Embed IO] r => InterpreterFor (Reader GtkState) r

Execute a GTK main loop in a baackground thread and interpret Reader GtkState. The clipboards stored in the state need the main loop running to work properly. The main loop is killed after the interpreted program terminates.

subscribeToClipboard :: Members [Events resource XClipboardEvent, Reader GtkState, Log, Embed IO, Final IO] r => Clipboard -> Selection -> Sem r ()

Listen to clipboard events for a specific source, like "primary selection", and publish them via Events.

clipboardEvents :: Members [Events resource XClipboardEvent, Reader GtkState, Log, Embed IO, Final IO] r => Sem r ()

Listen to clipboard events and publish them via Events.

listenXClipboard :: Members [Events resource XClipboardEvent, Log, Error Text, Race, Resource, Async, Embed IO, Final IO] r => InterpreterFor (Reader GtkState) r

Run a GTK main loop and listen to clipboard events, publishing them via Events.

type Api = "event" :> (Get '[JSON] [Event] :<|> ((ReqBody '[JSON] Event :> PostCreated '[JSON] NoContent) :<|> (ReqBody '[JSON] Int :> PutAccepted '[JSON] (Maybe Event))))

The Servant API of the daemon, providing endpoints for getting all events and creating one.

serve :: Members [History, Reader NetConfig, Sync ServerReady, Log, Interrupt, Final IO] r => Sem r ()

Run the daemon API.

listen :: Members [EventConsumer token Event, History, Sync Listening] r => Sem r ()

Listen for Event via Events, broadcasting them to agents.

yank :: Members [Reader InstanceName, Client, ChronosTime, Error Text, Embed IO] r => YankConfig -> Sem r ()

Send an event to the server.