winsize 1.0.0

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (C) 2011 by Samuel Kadolph
+
+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.md

@@ -0,0 +1,70 @@
+# ruby-winsize
+
+ruby-winsize is a small library that lets you get and set the winsize of a terminal.
+
+ruby-winsize adds two methods (`winsize` and `winsize=`) to for use with any
+`IO` instance for a TTY device. The `Winsize::Winsize` class is an intermediate
+form that is used for `ioctl` calls to the TTY device.
+
+## Installing
+
+### Recommended
+
+```
+gem install winsize
+```
+
+### Edge
+
+```
+git clone https://github.com/samuelkadolph/ruby-winsize
+cd ruby-winsize && rake install
+```
+
+## Usage
+
+To get the size of the `$stdout` terminal.
+
+```ruby
+require "winsize"
+
+size = $stdout.winsize
+puts "Your terminal is #{size.columns}x#{size.rows}"
+puts "Your terminal is #{size.horizontal_pixels}px*#{size.vertical_pixels}px"
+```
+
+To set the size of a pty terminal.
+This is useful if you are running a subshell and want the subshell to have the
+same output size as the terminal you yourself are running in.
+
+You might think it would be useful to set the winsize of `$stdout` it actually
+isn't since the terminal is usually limited by the monitor size or the terminal
+application and increasing the size messes with trimming logic.
+
+```ruby
+require "pty"
+require "winsize"
+
+size = Winsize.new(32, 160)
+# or
+# size = $stdout.winsize
+
+in, out, pid = PTY.spawn
+
+out.winsize = winsize
+# or
+# out.winsize = 32, 160
+```
+
+You may want to combine `winsize` and catching the [`SIGWINCH`](http://en.wikipedia.org/wiki/SIGWINCH) signal so you
+update something that your terminal has been resized.
+
+```ruby
+require "winsize"
+
+puts "Terminal size is #{$stdout.winsize.columns}x#{$stdout.winsize.rows}"
+
+Signal.trap "WINCH" do
+  puts "Terminal resized to #{$stdout.winsize.columns}x#{$stdout.winsize.rows}"
+end
+```

data/ext/extconf.rb

@@ -0,0 +1,5 @@
+require "mkmf"
+
+abort("ioctl is missing.\n\n") unless have_header("sys/ioctl.h")
+
+create_makefile("winsize")

data/ext/winsize.c

@@ -0,0 +1,9 @@
+#include "ruby.h"
+#include <sys/ioctl.h>
+
+void Init_winsize()
+{
+	VALUE rb_mWinSize = rb_define_module("Winsize");
+	rb_const_set(rb_mWinSize, rb_intern("TIOCGWINSZ"), ULONG2NUM(TIOCGWINSZ));
+	rb_const_set(rb_mWinSize, rb_intern("TIOCSWINSZ"), ULONG2NUM(TIOCSWINSZ));
+}

data/lib/winsize.rb

@@ -0,0 +1,36 @@
+require "winsize.so"
+require "winsize/version"
+
+module Winsize
+  class Winsize
+    attr_accessor :rows, :columns, :horizontal_pixels, :vertical_pixels
+
+    def initialize(rows, columns, horizontal_pixels = 0, vertical_pixels = 0)
+      @rows, @columns, @horizontal_pixels, @vertical_pixels = rows, columns, horizontal_pixels, vertical_pixels
+    end
+
+    def to_ioctl
+      [rows, columns, horizontal_pixels, vertical_pixels].pack("SSSS")
+    end
+  end
+
+  module IOExtensions
+    # TIOCGWINSZ & TIOCSWINSZ are defined in ext/winsize.c
+
+    def winsize
+      size = ""
+      ioctl(TIOCGWINSZ, size)
+      Winsize.new(*size.unpack("SSSS"))
+    end
+
+    def winsize=(size)
+      size = Winsize.new(*size) unless size.respond_to?(:to_ioctl)
+      size = size.to_ioctl
+      ioctl(TIOCSWINSZ, size)
+    end
+  end
+end
+
+class IO
+  include Winsize::IOExtensions
+end

data/lib/winsize/version.rb

@@ -0,0 +1,3 @@
+module WinSize
+  VERSION = "1.0.0"
+end

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification 
+name: winsize
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Samuel Kadolph
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-24 00:00:00 Z
+dependencies: []
+
+description: ruby-winsize adds two methods (winsize and winsize=) to for use with any IO instance for a TTY device. The Winsize::Winsize class is an intermediate form that is used for ioctl calls to the TTY device.
+email: 
+- samuel@kadolph.com
+executables: []
+
+extensions: 
+- ext/extconf.rb
+extra_rdoc_files: []
+
+files: 
+- ext/extconf.rb
+- ext/winsize.c
+- lib/winsize/version.rb
+- lib/winsize.rb
+- LICENSE
+- README.md
+homepage: https://github.com/samuelkadolph/ruby-winsize
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.1
+signing_key: 
+specification_version: 3
+summary: Small library that adds methods for getting and setting the winsize of any TTY IO object.
+test_files: []
+