i3-ipc 0.0.2

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Jan-Erik Rediger
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.markdown

@@ -0,0 +1,45 @@
+i3-ipc
+======
+
+inter-process communication with [i3][], the improved tiling window manager.
+
+Installation
+------------
+
+RubyGem:
+
+    gem install i3-ipc
+
+Old school:
+
+    curl -s http://github.com/badboy/i3-ipc/raw/master/i3-ipc > i3-ipc &&
+    chmod 755 i3-ipc &&
+    mv i3-ipc /usr/local/bin/i3-ipc
+
+Use
+---
+
+    i3-ipc -t 1
+    i3-ipc -t 1 -p
+    i3-ipc -t 1 -j
+    i3-ipc "exec xterm"
+
+Contributing
+------------
+
+Once you've made your great commits:
+
+1. [Fork][0] the project.
+2. Create a topic branch - `git checkout -b my_branch`
+3. Push to your branch - `git push origin my_branch`
+4. Create an [Issue][1] with a link to your branch
+5. That's it!
+
+Copyright
+---------
+
+Copyright (c) 2010 Jan-Erik Rediger. See LICENSE for details.
+
+[i3]: http://i3.zekjur.net/
+[0]: http://help.github.com/forking/
+[1]: http://github.com/badboy/i3-ipc/issues

data/Rakefile

@@ -0,0 +1,50 @@
+begin
+  require 'mg'
+  MG.new("i3-ipc.gemspec")
+rescue LoadError
+  nil
+end
+
+desc "Build standalone script"
+task :build => [ :standalone, :build_man ]
+
+desc "Build standalone script"
+task :standalone => :load_i3_ipc do
+  require 'i3-ipc/standalone'
+  I3::Standalone.save('i3-ipc')
+end
+
+desc "Build i3-ipc manual"
+task :build_man do
+  sh "ronn -br5 --organization=badboy --manual='i3-ipc Manual' man/*.ronn"
+end
+
+desc "Show i3-ipc manual"
+task :man => :build_man do
+  exec "man man/i3-ipc.1"
+end
+
+task :load_i3_ipc do
+  $LOAD_PATH.unshift 'lib'
+  require 'i3-ipc'
+end
+
+Rake::TaskManager.class_eval do
+  def remove_task(task_name)
+    @tasks.delete(task_name.to_s)
+  end
+end
+
+# Remove mg's install task
+Rake.application.remove_task(:install)
+
+desc "Install standalone script and man pages"
+task :install => :standalone do
+  prefix = ENV['PREFIX'] || ENV['prefix'] || '/usr/local'
+
+  FileUtils.mkdir_p "#{prefix}/bin"
+  FileUtils.cp "i3-ipc", "#{prefix}/bin"
+
+  FileUtils.mkdir_p "#{prefix}/share/man/man1"
+  FileUtils.cp "man/i3-ipc.1", "#{prefix}/share/man/man1"
+end

data/bin/i3-ipc

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+# encoding: utf-8
+
+require 'i3-ipc'
+I3::Runner.execute(*ARGV)

data/lib/i3-ipc.rb

@@ -0,0 +1,93 @@
+require 'socket'
+require 'json'
+require 'i3-ipc/runner'
+require 'i3-ipc/manpage'
+require 'i3-ipc/version'
+
+module I3
+  class IPC
+    MAGIC_STRING = "i3-ipc"
+
+    class WrongAnswer < RuntimeError; end # :nodoc:
+    class WrongType < RuntimeError; end # :nodoc:
+
+    # connects to the given i3 ipc interface
+    # @param socket_path String the path to i3's socket
+    # @param force_connect Boolean connects to the socket if true
+    def initialize(socket_path="/tmp/i3-ipc.sock", force_connect=false)
+      @socket_path = socket_path
+      connect if connect
+    end
+
+    # send a message to i3
+    #
+    # the message is a command for i3
+    # (like the commands you can bind to keys in the configuration file)
+    # and will be executed directly after receiving it.
+    #
+    # returns { "success" => true }
+    def message(payload)
+      write format(0, payload)
+      handle_response 0
+    end
+
+    # gets the current workspaces.
+    # the reply will be the JSON-encoded list of workspaces
+    # (see the reply section of i3 docu)
+    def get_workspace
+      write format(1)
+      handle_response 1
+    end
+
+    # reads the reply from the socket
+    # and parse the returned json into a ruby object
+    #
+    # throws WrongAnswer when magic word is wrong
+    # throws WrongType if returned type does not match expected
+    def handle_response(type)
+      # reads 14 bytes
+      # length of "i3-ipc" + 4 bytes length + 4 bytes type
+      buffer = @socket.read 14
+      raise WrongAnswer unless buffer[0, ("i3-ipc".length)]
+
+      len, recv_type = buffer[6..-1].unpack("LL")
+      raise WrongType unless recv_type == type
+
+      answer = @socket.read(len)
+      ::JSON.parse(answer)
+    end
+
+    # format the message
+    # a typical message looks like
+    #   "i3-ipc" <message length> <message type> <payload>
+    def format(type, payload=nil)
+      size = payload ? payload.to_s.bytes.count : 0
+      msg = "i3-ipc%s" % [size, type].pack("LL")
+      msg << payload.to_s if payload
+      msg
+    end
+
+    # writes message to the socket
+    # if socket is not connected, it calls conenct
+    def write(msg)
+      connect if @socket.nil? || closed?
+      @last_write_length = @socket.write msg
+    end
+
+    # connects to the given socket
+    def connect
+      @socket = UNIXSocket.new(@socket_path)
+    end
+
+    # closes the socket connection
+    def close
+      @socket.close
+    end
+
+    # alias for @socket.closed? for easy access
+    def closed?
+      @socket.closed?
+    end
+  end
+end
+

data/lib/i3-ipc/manpage.rb

@@ -0,0 +1,90 @@
+module I3
+  module Manpage
+    extend self
+
+    # Prints a manpage, all pretty and paged.
+    def display(name)
+      puts manpage(name)
+    end
+
+    # Returns the terminal-formatted manpage, ready to be printed to
+    # the screen.
+    def manpage(name)
+      return "** Can't find groff(1)" unless groff?
+
+      require 'open3'
+      out = nil
+      Open3.popen3(groff_command) do |stdin, stdout, _|
+        stdin.puts raw_manpage(name)
+        stdin.close
+        out = stdout.read.strip
+      end
+      out
+    end
+
+    # Returns the raw manpage. If we're not running in standalone
+    # mode, it's a file sitting at the root under the `man`
+    # directory.
+    #
+    # If we are running in standalone mode the manpage will be
+    # included after the __END__ of the file so we can grab it using
+    # DATA.
+    def raw_manpage(name)
+      if File.exists? file = File.dirname(__FILE__) + "/../../man/#{name}.1"
+        File.read(file)
+      else
+        DATA.read
+      end
+    end
+
+    # Returns true if groff is installed and in our path, false if
+    # not.
+    def groff?
+      system("which groff > /dev/null")
+    end
+
+    # The groff command complete with crazy arguments we need to run
+    # in order to turn our raw roff (manpage markup) into something
+    # readable on the terminal.
+    def groff_command
+      "groff -Wall -mtty-char -mandoc -Tascii"
+    end
+
+    # All calls to `puts` are paged, git-style.
+    def puts(*args)
+      page_stdout
+      super
+    end
+
+    # http://nex-3.com/posts/73-git-style-automatic-paging-in-ruby
+    def page_stdout
+      return unless $stdout.tty?
+
+      read, write = IO.pipe
+
+      if Kernel.fork
+        # Parent process, become pager
+        $stdin.reopen(read)
+        read.close
+        write.close
+
+        # Don't page if the input is short enough
+        ENV['LESS'] = 'FSRX'
+
+        # Wait until we have input before we start the pager
+        Kernel.select [STDIN]
+
+        pager = ENV['PAGER'] || 'less -isr'
+        pager = 'cat' if pager.empty?
+
+        exec pager rescue exec "/bin/sh", "-c", pager
+      else
+        # Child process
+        $stdout.reopen(write)
+        $stderr.reopen(write) if $stderr.tty?
+        read.close
+        write.close
+      end
+    end
+  end
+end

data/lib/i3-ipc/runner.rb

@@ -0,0 +1,76 @@
+require 'optparse'
+
+module I3
+  module Runner
+    extend self
+
+    def execute(*args)
+      socket_file = '/tmp/i3-ipc.sock'
+      type = 0
+      quiet = false
+      output = :default
+
+      opts = OptionParser.new do |opts|
+        opts.banner = "Usage: i3-ipc [options] [message]"
+
+        s_desc = 'Set socket file, defaults to /tmp/i3-ipc.sock'
+        opts.on('-s', '--socket', s_desc) do |s|
+          socket_file = s
+        end
+
+        t_desc = 'Set type, 0 = command, 1 = workspace list, defaults to 0'
+        opts.on('-tTYPE', '--type TYPE', Integer, t_desc) do |t|
+          type = t
+        end
+
+        opts.on('-p', '--pretty-print', 'Pretty print reply') do |p|
+          output = :pretty_print
+        end
+
+        opts.on('-j', '--json', 'Output raw json') do |p|
+          output = :json
+        end
+
+        opts.on('-q', '--quiet', %(Don't show reply)) do |q|
+          quiet = q
+        end
+
+        opts.on('-m', '--man', 'Print manual') do
+          I3::Manpage.display("i3-ipc")
+        end
+
+        opts.on('-h', '--help', 'Display this screen') do
+          puts opts
+          exit
+        end
+      end
+
+      opts.parse!(args)
+
+      s = I3::IPC.new(socket_file)
+
+      if type == 0
+        if args.empty?
+          abort "error: message type needs a message"
+        end
+
+        payload = args.shift
+
+        puts s.message(payload) unless quiet
+      elsif type == 1
+        workspaces = s.get_workspace
+        if output == :pretty_print
+          require 'pp'
+          pp workspaces
+        elsif output == :json
+          require 'json'
+          puts workspaces.to_json
+        else
+          p workspaces
+        end
+      else
+        abort "error: type #{type} not yet implemented"
+      end
+    end
+  end
+end

data/lib/i3-ipc/standalone.rb

@@ -0,0 +1,53 @@
+module I3
+  module Standalone
+    extend self
+
+    PREAMBLE = <<-preamble
+#!/usr/bin/env ruby
+#
+# This file, gist, is generated code.
+# Please DO NOT EDIT or send patches for it.
+#
+# Please take a look at the source from
+# http://github.com/badboy/i3-ipc
+# and submit patches against the individual files
+# that build gist.
+#
+
+preamble
+
+    POSTAMBLE = "I3::Runner.execute(*ARGV)\n"
+    __DIR__   = File.dirname(__FILE__)
+    MANPAGE   = "__END__\n#{File.read(__DIR__ + '/../../man/i3-ipc.1')}"
+
+    def save(filename, path = '.')
+      target = File.join(File.expand_path(path), filename)
+      File.open(target, 'w') do |f|
+        f.puts build
+        f.chmod 0755
+      end
+    end
+
+    def build
+      root = File.dirname(__FILE__)
+
+      standalone = ''
+      standalone << PREAMBLE
+
+      Dir["#{root}/../**/*.rb"].each do |file|
+        # skip standalone.rb
+        next if File.expand_path(file) == File.expand_path(__FILE__)
+
+        File.readlines(file).each do |line|
+          next if line =~ /^\s*#/
+          next if line =~ /^require 'i3-ipc/
+          standalone << line
+        end
+      end
+
+      standalone << POSTAMBLE
+      standalone << MANPAGE
+      standalone
+    end
+  end
+end

data/lib/i3-ipc/version.rb

@@ -0,0 +1,3 @@
+module I3
+  Version = '0.0.2'
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification 
+name: i3-ipc
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 2
+  version: 0.0.2
+platform: ruby
+authors: 
+- Jan-Erik Rediger
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-12 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: "  uses the ipc socket of i3 to send commands or get information directly from the window manager. Useful for scripting the window manager.'\n"
+email: badboy@archlinux.us
+executables: 
+- i3-ipc
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.markdown
+- Rakefile
+- LICENSE
+- lib/i3-ipc/manpage.rb
+- lib/i3-ipc/standalone.rb
+- lib/i3-ipc/version.rb
+- lib/i3-ipc/runner.rb
+- lib/i3-ipc.rb
+- bin/i3-ipc
+has_rdoc: true
+homepage: http://github.com/badboy/i3-ipc
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: inter-process communication with i3, the improved tiling window manager.
+test_files: []
+