i3-ipc 0.1.2 → 0.1.3

data/README.markdown

@@ -26,7 +26,7 @@ Use
 
     i3-ipc -t 1
     i3-ipc -t 1 -p
-    i3-ipc -t 1 -j
+    i3-ipc -t 3 -j
     i3-ipc "exec xterm"
 
 Read the [man-page][man] for more information.
@@ -35,10 +35,14 @@ Subscribing
 -----------
 
 As of commit [3db4890][] i3 added events.
-For now there's only one event: `workspace`.
+For now there's only two events: `workspace` and `focus`.
 
 According to the documentation:
-> This event is sent when the user switches to a different workspace, when a new workspace is initialized or when a workspace is removed (because the last client vanished).
+> workspace
+>   Sent when the user switches to a different workspace, when a new workspace is initialized or when a workspace is removed (because the last client vanished).
+> output
+>   Sent when RandR issues a change notification (of either screens, outputs, CRTCs or output properties).
+
 
 i3-ipc uses [EventMachine][em] to receive and handle these events.
 
@@ -55,9 +59,10 @@ To send data to the socket, you need to use `em.send_data`.
 * `type` is the received message type.
 This could be one of
   * MESSAGE_REPLY_COMMAND
-  * MESSAGE_REPLY_COMMAND
-  * MESSAGE_REPLY_COMMAND
-  * EVENT_WORKSPACE #_
+  * MESSAGE_REPLY_GET_WORKSPACES
+  * MESSAGE_REPLY_SUBSCRIBE
+  * MESSAGE_REPLY_GET_OUTPUTS
+  * EVENT_WORKSPACE
 * `data` is the received data, already parsed.
 
 For example you can use the following code to get the actual focused screen:

data/Rakefile

@@ -9,7 +9,7 @@ begin
   task :publish => :gemcutter do
     require File.dirname(__FILE__) + '/lib/i3-ipc/version'
 
-    system "git tag v#{I3::Version}"
+    sh "git tag v#{I3::Version}"
     sh "git push origin master --tags"
     sh "git clean -fd"
     exec "rake pages"

data/lib/i3-ipc.rb

@@ -13,10 +13,12 @@ module I3
     MESSAGE_TYPE_COMMAND = 0
     MESSAGE_TYPE_GET_WORKSPACES = 1
     MESSAGE_TYPE_SUBSCRIBE = 2
+    MESSAGE_TYPE_GET_OUTPUTS = 3
 
     MESSAGE_REPLY_COMMAND = 0
     MESSAGE_REPLY_GET_WORKSPACES = 1
     MESSAGE_REPLY_SUBSCRIBE = 2
+    MESSAGE_REPLY_GET_OUTPUTS = 3
 
     EVENT_MASK = (1 << 31)
     EVENT_WORKSPACE = (EVENT_MASK | 0)
@@ -58,6 +60,15 @@ module I3
       handle_response MESSAGE_TYPE_GET_WORKSPACES
     end
 
+    # Gets the current outputs.
+    # The reply will be a JSON-encoded list
+    # of outputs
+    # (see the reply section of i3 docu).
+    def get_outputs
+      write format(MESSAGE_TYPE_GET_OUTPUTS)
+      handle_response MESSAGE_TYPE_GET_OUTPUTS
+    end
+
     # reads the reply from the socket
     # and parse the returned json into a ruby object
     #

data/lib/i3-ipc/runner.rb

@@ -1,9 +1,33 @@
 require 'optparse'
+require 'pp'
 
 module I3
   module Runner
     extend self
 
+    def format_output(object, output)
+      if output == :pretty_print
+        pp object
+      elsif output == :json
+        require 'json'
+        puts object.to_json
+      else
+        p object
+      end
+    end
+
+    def subscribe(path, output)
+      trap('SIGINT') { EM.stop; puts }
+      I3::IPC.subscribe([:workspace], path) do |em, type, data|
+        case type
+        when I3::IPC::MESSAGE_REPLY_GET_WORKSPACES
+          format_output data, output
+        when I3::IPC::EVENT_WORKSPACE
+          em.send_data I3::IPC.format(I3::IPC::MESSAGE_TYPE_GET_WORKSPACES)
+        end
+      end
+    end
+
     def execute(*args)
       socket_file = '/tmp/i3-ipc.sock'
       type = 0
@@ -18,7 +42,7 @@ module I3
           socket_file = s
         end
 
-        t_desc = 'Set type, 0 = command, 1 = workspace list, defaults to 0'
+        t_desc = 'Set type, 0 = command, 1 = workspace list, 2 = subscribe to workspace event, 3 = output list, default: 0'
         opts.on('-tTYPE', '--type TYPE', Integer, t_desc) do |t|
           type = t
         end
@@ -49,7 +73,8 @@ module I3
 
       s = I3::IPC.new(socket_file)
 
-      if type == 0
+      case type
+      when 0
         if args.empty?
           abort "error: message type needs a message"
         end
@@ -57,17 +82,12 @@ module I3
         payload = args.shift
 
         puts s.command(payload) unless quiet
-      elsif type == 1
-        workspaces = s.get_workspaces
-        if output == :pretty_print
-          require 'pp'
-          pp workspaces
-        elsif output == :json
-          require 'json'
-          puts workspaces.to_json
-        else
-          p workspaces
-        end
+      when I3::IPC::MESSAGE_TYPE_GET_WORKSPACES
+        format_output s.get_workspaces, output
+      when I3::IPC::MESSAGE_REPLY_SUBSCRIBE
+        subscribe socket_file, output
+      when I3::IPC::MESSAGE_TYPE_GET_OUTPUTS
+        format_output s.get_outputs, output
       else
         abort "error: type #{type} not yet implemented"
       end

data/lib/i3-ipc/standalone.rb

@@ -34,7 +34,7 @@ preamble
       standalone = ''
       standalone << PREAMBLE
       file_dir = File.expand_path(File.dirname(__FILE__))
-      exclude_files = %w(subscription.rb)
+      exclude_files = %w()
 
       exclude_file_list = exclude_files.map { |file|
         File.join(file_dir, file)

data/lib/i3-ipc/version.rb

@@ -1,3 +1,3 @@
 module I3
-  Version = '0.1.2'
+  Version = '0.1.3'
 end

data/man/i3-ipc.1

@@ -0,0 +1,88 @@
+.\" generated with Ronn/v0.4.1
+.\" http://github.com/rtomayko/ronn/
+.
+.TH "I3\-IPC" "1" "March 2010" "badboy" "i3-ipc Manual"
+.
+.SH "NAME"
+\fBi3\-ipc\fR \-\- inter\-process communication with i3
+.
+.SH "SYNOPSIS"
+\fBi3\-ipc\fR [\fB\-s\fR] [\fB\-t type\fR] [\fB\-p\fR] [\fB\-j\fR] [\fB\-q\fR] [\fBmessage\fR]
+.
+.SH "DESCRIPTION"
+\fBi3\-ipc\fR can be used to communicate with i3, the improved tiling window manager, through the provided ipc socket. Useful for scripting the window manager.
+.
+.P
+Currently implemented message types of i3 are the following:
+.
+.TP
+\fB0 (COMMAND)\fR
+  The payload of the message is a command for i3
+  (like the commands you can bind to keys in the configuration file)
+  The command will be executed directly after receiving it.
+  The reply will be always {"succes":true} for now.
+.
+.TP
+\fB1 (GET_WORKSPACES)\fR
+  Gets the current workspaces.
+  The reply will be a JSON\-encoded list of workspaces (see the reply section).
+.
+.SH "OPTIONS"
+\fBi3\-ipc\fR's default mode of operation is to send the command (type 0) specified on the command line.
+.
+.P
+These options can be used to change this behavior:
+.
+.TP
+\fB\-s\fR, \fB\-\-socket\fR
+Set the socket file, defaults to /tmp/i3\-ipc.sock
+.
+.TP
+\fB\-t\fR, \fB\-\-type\fR
+Set the type. Passing a type of 0 is the default and will send the specified command, type 1 gets the current workspace list.
+.
+.TP
+\fB\-p\fR, \fB\-\-pretty\-print\fR
+This will pretty print the received reply. Useful for the workspace list.
+.
+.TP
+\fB\-j\fR, \fB\-\-json\fR
+This will print the received reply as raw json\-encoded data. Useful to pass to another script.
+.
+.TP
+\fB\-q\fR, \fB\-\-quiet\fR
+Turn off the output. Useful for command mode.
+.
+.TP
+\fBmessage\fR
+This is the actual command to send as defined by i3
+.
+.P
+You may additionally ask for help:
+.
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+Print help.
+.
+.TP
+\fB\-m\fR, \fB\-\-man\fR
+Display this man page.
+.
+.SH "EXAMPLES"
+.
+.nf
+$ i3\-ipc \-t 1
+$ i3\-ipc \-t 1 \-p
+$ i3\-ipc \-t 1 \-j
+$ i3\-ipc "exec xterm"
+.
+.fi
+.
+.SH "BUGS"
+\fIhttp://github.com/badboy/i3\-ipc/issues\fR
+.
+.SH "AUTHOR"
+Jan\-Erik Rediger:: badboy@archlinux.us
+.
+.SH "SEE ALSO"
+i3(1), i3\-msg(1), \fIhttp://i3.zekjur.net/\fR, \fIhttp://github.com/badboy/i3\-ipc\fR

data/man/i3-ipc.1.html

@@ -0,0 +1,141 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <meta http-equiv='content-type' value='text/html;charset=utf8'>
+  <meta name='generator' value='Ronn/v0.4.1'>
+  <title>i3-ipc(1) -- inter-process communication with i3</title>
+  <style type='text/css'>
+    body {margin:0}
+    #man, #man code, #man pre, #man tt, #man kbd, #man samp {
+      font-family:consolas,monospace;
+      font-size:16px;
+      line-height:1.3;
+      color:#343331;
+      background:#fff; }
+    #man { max-width:89ex; text-align:justify; margin:0 25px 25px 25px }
+    #man h1, #man h2, #man h3 { color:#232221;clear:left }
+    #man h1 { font-size:28px; margin:15px 0 30px 0; text-align:center }
+    #man h2 { font-size:18px; margin-bottom:0; margin-top:10px; line-height:1.3; }
+    #man h3 { font-size:16px; margin:0 0 0 4ex; }
+    #man p, #man ul, #man ol, #man dl, #man pre { margin:0 0 18px 0; }
+    #man pre {
+      color:#333231;
+      background:#edeceb;
+      padding:5px 7px;
+      margin:0px 0 20px 0;
+      border-left:2ex solid #ddd}
+    #man pre + h2, #man pre + h3 {
+      margin-top:22px;
+    }
+    #man h2 + pre, #man h3 + pre {
+      margin-top:5px;
+    }
+    #man > p, #man > ul, #man > ol, #man > dl, #man > pre { margin-left:8ex; }
+    #man dt { margin:0; clear:left }
+    #man dt.flush { float:left; width:8ex }
+    #man dd { margin:0 0 0 9ex }
+    #man code, #man strong, #man b { font-weight:bold; color:#131211; }
+    #man pre code { font-weight:normal; color:#232221; background:inherit }
+    #man em, var, u {
+      font-style:normal; color:#333231; border-bottom:1px solid #999; }
+    #man h1.man-title { display:none; }
+    #man ol.man, #man ol.man li { margin:2px 0 10px 0; padding:0;
+      float:left; width:33%; list-style-type:none;
+      text-transform:uppercase; font-size:18px; color:#999;
+      letter-spacing:1px;}
+    #man ol.man { width:100%; }
+    #man ol.man li.tl { text-align:left }
+    #man ol.man li.tc { text-align:center;letter-spacing:4px }
+    #man ol.man li.tr { text-align:right }
+    #man ol.man a { color:#999 }
+    #man ol.man a:hover { color:#333231 }
+  </style>
+</head>
+<body>
+<div id='man'>
+
+<h1 class='man-title'>i3-ipc(1)</h1>
+
+<ol class='head man'>
+  <li class='tl'>i3-ipc(1)</li>
+  <li class='tc'>i3-ipc Manual</li>
+  <li class='tr'>i3-ipc(1)</li>
+</ol>
+
+<h2 id='NAME'>NAME</h2>
+<p><code>i3-ipc</code> -- inter-process communication with i3</p>
+
+<h2>SYNOPSIS</h2>
+
+<p><code>i3-ipc</code> [<code>-s</code>] [<code>-t type</code>] [<code>-p</code>] [<code>-j</code>] [<code>-q</code>] [<code>message</code>]</p>
+
+<h2>DESCRIPTION</h2>
+
+<p><code>i3-ipc</code> can be used to communicate with i3, the improved tiling window manager, through the provided ipc socket. Useful for scripting the window manager.</p>
+
+<p>Currently implemented message types of i3 are the following:</p>
+
+<dl>
+<dt><code>0 (COMMAND)</code></dt><dd>  The payload of the message is a command for i3
+  (like the commands you can bind to keys in the configuration file)
+  The command will be executed directly after receiving it.
+  The reply will be always {"succes":true} for now.</dd>
+<dt><code>1 (GET_WORKSPACES)</code></dt><dd>  Gets the current workspaces.
+  The reply will be a JSON-encoded list of workspaces (see the reply section).</dd>
+</dl>
+
+
+<h2>OPTIONS</h2>
+
+<p><code>i3-ipc</code>'s default mode of operation is to send the command (type 0) specified on the command line.</p>
+
+<p>These options can be used to change this behavior:</p>
+
+<dl>
+<dt><code>-s</code>, <code>--socket</code></dt><dd><p>Set the socket file, defaults to /tmp/i3-ipc.sock</p></dd>
+<dt><code>-t</code>, <code>--type</code></dt><dd><p>Set the type. Passing a type of 0 is the default and will send the specified command, type 1 gets the current workspace list.</p></dd>
+<dt><code>-p</code>, <code>--pretty-print</code></dt><dd><p>This will pretty print the received reply. Useful for the workspace list.</p></dd>
+<dt><code>-j</code>, <code>--json</code></dt><dd><p>This will print the received reply as raw json-encoded data. Useful to pass to another script.</p></dd>
+<dt><code>-q</code>, <code>--quiet</code></dt><dd><p>Turn off the output. Useful for command mode.</p></dd>
+<dt class="flush"><code>message</code></dt><dd><p>This is the actual command to send as defined by i3</p></dd>
+</dl>
+
+
+<p>You may additionally ask for help:</p>
+
+<dl>
+<dt><code>-h</code>, <code>--help</code></dt><dd><p>Print help.</p></dd>
+<dt><code>-m</code>, <code>--man</code></dt><dd><p>Display this man page.</p></dd>
+</dl>
+
+
+<h2>EXAMPLES</h2>
+
+<pre><code>$ i3-ipc -t 1
+$ i3-ipc -t 1 -p
+$ i3-ipc -t 1 -j
+$ i3-ipc "exec xterm"
+</code></pre>
+
+<h2>BUGS</h2>
+
+<p><a href="http://github.com/badboy/i3-ipc/issues">http://github.com/badboy/i3-ipc/issues</a></p>
+
+<h2>AUTHOR</h2>
+
+<p>Jan-Erik Rediger:: badboy@archlinux.us</p>
+
+<h2>SEE ALSO</h2>
+
+<p>i3(1), i3-msg(1), <a href="http://i3.zekjur.net/">http://i3.zekjur.net/</a>, <a href="http://github.com/badboy/i3-ipc">http://github.com/badboy/i3-ipc</a></p>
+
+
+<ol class='foot man'>
+  <li class='tl'>badboy</li>
+  <li class='tc'>March 2010</li>
+  <li class='tr'>i3-ipc(1)</li>
+</ol>
+
+</div>
+</body>
+</html>

data/man/i3-ipc.1.ronn

@@ -0,0 +1,73 @@
+i3-ipc(1) -- inter-process communication with i3
+================================================
+
+## SYNOPSIS
+
+`i3-ipc` [`-s`] [`-t type`] [`-p`] [`-j`] [`-q`] [`message`]
+
+## DESCRIPTION
+
+`i3-ipc` can be used to communicate with i3, the improved tiling window manager, through the provided ipc socket. Useful for scripting the window manager.
+
+
+Currently implemented message types of i3 are the following:
+
+  * `0 (COMMAND)`:
+      The payload of the message is a command for i3
+      (like the commands you can bind to keys in the configuration file) 
+      The command will be executed directly after receiving it.
+      The reply will be always {"succes":true} for now.
+  * `1 (GET_WORKSPACES)`:
+      Gets the current workspaces. 
+      The reply will be a JSON-encoded list of workspaces (see the reply section).
+
+## OPTIONS
+
+`i3-ipc`'s default mode of operation is to send the command (type 0) specified on the command line.
+
+These options can be used to change this behavior:
+
+  * `-s`, `--socket`:
+    Set the socket file, defaults to /tmp/i3-ipc.sock
+
+  * `-t`, `--type`:
+    Set the type. Passing a type of 0 is the default and will send the specified command, type 1 gets the current workspace list.
+
+  * `-p`, `--pretty-print`:
+    This will pretty print the received reply. Useful for the workspace list.
+
+  * `-j`, `--json`:
+    This will print the received reply as raw json-encoded data. Useful to pass to another script.
+
+  * `-q`, `--quiet`:
+    Turn off the output. Useful for command mode.
+
+  * `message`:
+    This is the actual command to send as defined by i3
+
+You may additionally ask for help:
+
+  * `-h`, `--help`:
+    Print help.
+
+  * `-m`, `--man`:
+    Display this man page.
+
+## EXAMPLES
+
+    $ i3-ipc -t 1
+    $ i3-ipc -t 1 -p
+    $ i3-ipc -t 1 -j
+    $ i3-ipc "exec xterm"
+
+## BUGS
+
+<http://github.com/badboy/i3-ipc/issues>
+
+## AUTHOR
+
+Jan-Erik Rediger:: badboy@archlinux.us
+
+## SEE ALSO
+
+i3(1), i3-msg(1), <http://i3.zekjur.net/>, <http://github.com/badboy/i3-ipc>

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 2
-  version: 0.1.2
+  - 3
+  version: 0.1.3
 platform: ruby
 authors: 
 - Jan-Erik Rediger
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-14 00:00:00 +01:00
+date: 2010-04-08 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -78,6 +78,9 @@ files:
 - lib/i3-ipc/runner.rb
 - lib/i3-ipc.rb
 - bin/i3-ipc
+- man/i3-ipc.1.html
+- man/i3-ipc.1
+- man/i3-ipc.1.ronn
 has_rdoc: true
 homepage: http://github.com/badboy/i3-ipc
 licenses: []