osxhotkey 0.0.1

data/CHANGELOG

@@ -0,0 +1,5 @@
+
+== 0.0.1 / 2006-11-13
+
+* initial release
+

data/README

@@ -0,0 +1,29 @@
+
+osx/hotkey
+by cho45 <cho45@lowreal.net>
+
+== DESCRIPTION:
+Enable Hotkey integraion with Ruby/Cocoa
+
+== FEATURES/PROBLEMS:
+
+* Add a new NSApplication subclass named NSApplicationWithHotKey
+
+== SYNOPSYS:
+
+	require 'osx/cocoa'
+	require 'osx/hotkey'
+
+	app = NSApplicationWithHotKey.sharedApplication
+	ref = app.register_hotkey("Command+Shift+J") do
+		puts 'hello'
+	end
+
+	app.run
+
+Yes. Run this script, and press Command+Shift+J, and see 'hello' on stdout.
+
+== LICENSE:
+
+Ruby's
+

data/Rakefile

@@ -0,0 +1,120 @@
+require 'rubygems'
+require 'rake'
+require 'rake/clean'
+require 'rake/testtask'
+require 'rake/packagetask'
+require 'rake/gempackagetask'
+require 'rake/rdoctask'
+require 'rake/contrib/rubyforgepublisher'
+require 'fileutils'
+include FileUtils
+
+AUTHOR = "cho45"
+EMAIL = "cho45@lowreal.net"
+DESCRIPTION = "HotKey integration with Ruby/Cocoa"
+RUBYFORGE_PROJECT = "osxhotkey"
+HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
+BIN_FILES = %w(  )
+VERS = "0.0.1"
+
+
+NAME = "osxhotkey"
+REV = File.read(".svn/entries")[/committed-rev="(d+)"/, 1] rescue nil
+CLEAN.include ['**/.*.sw?', '*.gem', '.config']
+RDOC_OPTS = ['--quiet', '--title', "osxhotkey documentation",
+	"--opname", "index.html",
+	"--line-numbers", 
+	"--main", "README",
+	"--inline-source"]
+
+desc "Packages up osxhotkey gem."
+task :default => [:test]
+task :package => [:clean]
+
+Rake::TestTask.new("test") { |t|
+	sh %{ruby setup.rb config}
+	sh %{ruby setup.rb setup}
+	t.libs << "test"
+	t.libs << "ext"
+	t.pattern = "test/**/*_test.rb"
+	t.verbose = true
+}
+
+spec = Gem::Specification.new do |s|
+	s.name = NAME
+	s.version = VERS
+	s.platform = Gem::Platform::RUBY
+	s.has_rdoc = true
+	s.extra_rdoc_files = ["README", "CHANGELOG"]
+	s.rdoc_options += RDOC_OPTS + ['--exclude', '^(examples|extras)/']
+	s.summary = DESCRIPTION
+	s.description = DESCRIPTION
+	s.author = AUTHOR
+	s.email = EMAIL
+	s.homepage = HOMEPATH
+	s.executables = BIN_FILES
+	s.rubyforge_project = RUBYFORGE_PROJECT
+	s.bindir = "bin"
+	s.require_path = "lib"
+	s.autorequire = "osx/hotkey"
+	s.test_files = Dir["test/test_*.rb"]
+
+	#s.add_dependency('activesupport', '>=1.3.1')
+	#s.required_ruby_version = '>= 1.8.2'
+
+	s.files = %w(README CHANGELOG Rakefile) +
+		Dir.glob("{bin,doc,test,lib,templates,generator,extras,website,script}/**/*") + 
+		Dir.glob("ext/**/*.{h,c,rb}") +
+		Dir.glob("examples/**/*.rb") +
+		Dir.glob("tools/*.rb")
+
+	s.extensions = FileList["ext/**/extconf.rb"].to_a
+end
+
+Rake::GemPackageTask.new(spec) do |p|
+	p.need_tar = true
+	p.gem_spec = spec
+end
+
+task :install do
+	name = "#{NAME}-#{VERS}.gem"
+	sh %{rake package}
+	sh %{sudo gem install pkg/#{name}}
+end
+
+task :uninstall => [:clean] do
+	sh %{sudo gem uninstall #{NAME}}
+end
+
+
+Rake::RDocTask.new do |rdoc|
+	rdoc.rdoc_dir = 'html'
+	rdoc.options += RDOC_OPTS
+	rdoc.template = "#{ENV['template']}.rb" if ENV['template']
+	if ENV['DOC_FILES']
+		rdoc.rdoc_files.include(ENV['DOC_FILES'].split(/,\s*/))
+	else
+		rdoc.rdoc_files.include('README', 'CHANGELOG')
+		rdoc.rdoc_files.include('lib/**/*.rb')
+	end
+end
+
+desc "Publish to RubyForge"
+task :rubyforge => [:rdoc, :package] do
+	Rake::RubyForgePublisher.new(RUBYFORGE_PROJECT, 'cho45').upload
+end
+
+desc "Publish to lab"
+task :publab do
+	require 'rake/contrib/sshpublisher'
+
+	path = File.expand_path(File.dirname(__FILE__))
+
+	Rake::SshDirPublisher.new(
+		"cho45@lab.lowreal.net",
+		"/srv/www/lab.lowreal.net/public/site-ruby",
+		path + "/pkg"
+	).upload
+end
+
+

data/ext/extconf.rb

@@ -0,0 +1,7 @@
+#!/usr/bin/ruby
+
+require 'mkmf'
+$CFLAGS << " -framework Carbon "
+$LDFLAGS << " -framework Carbon "
+create_makefile 'osxhotkey'
+

data/ext/osxhotkey.c

@@ -0,0 +1,85 @@
+
+#include <Carbon/Carbon.h>
+#include <ruby.h>
+
+struct rhk {
+	EventHotKeyRef hotkeyref;
+};
+
+static VALUE
+rhk_alloc(VALUE klass) {
+	struct rhk* ptr = ALLOC(struct rhk);
+
+	return Data_Wrap_Struct(klass, 0, -1, ptr);
+}
+
+static VALUE
+rhk_initialize(VALUE self, VALUE keyCode, VALUE modifiers) {
+	rb_ivar_set(self, rb_intern("@keyCode"), keyCode);
+	rb_ivar_set(self, rb_intern("@modifiers"), modifiers);
+
+	return Qnil;
+}
+
+static VALUE
+rhk_register(VALUE self) {
+	static UInt32 _id = 0;
+	VALUE modifiers, keyCode;
+
+	keyCode   = rb_ivar_get(self, rb_intern("@keyCode"));
+	modifiers = rb_ivar_get(self, rb_intern("@modifiers"));
+
+	UInt32 modifier = NUM2INT(modifiers);
+
+	EventHotKeyID keyId;
+	keyId.signature = 'HtKe';
+	keyId.id = _id++;
+
+	EventHotKeyRef hotKeyRef;
+	OSStatus status = RegisterEventHotKey(
+			NUM2INT(keyCode),
+			modifier,
+			keyId,
+			GetApplicationEventTarget(),
+			0,
+			&hotKeyRef
+	);
+
+	if (status != noErr) rb_raise(rb_eStandardError, "RegisterEventHotKey returned Error status");
+
+	struct rhk* ptr;
+	Data_Get_Struct(self, struct rhk, ptr);
+	ptr->hotkeyref = hotKeyRef;
+
+	return INT2NUM((unsigned int)hotKeyRef);
+}
+
+static VALUE
+rhk_unregister(VALUE self) {
+	struct rhk* ptr;
+	Data_Get_Struct(self, struct rhk, ptr);
+	UnregisterEventHotKey(ptr->hotkeyref);
+	return Qtrue;
+}
+
+void
+Init_osxhotkey () {
+	VALUE HotKey;
+	VALUE module;
+
+	rb_eval_string("require 'osx/cocoa'");
+	module = rb_eval_string("OSX");
+
+	HotKey = rb_define_class_under(module, "HotKey", rb_cObject);
+	rb_define_const(HotKey, "SHIFT", INT2NUM(shiftKey));
+	rb_define_const(HotKey, "CONTROL", INT2NUM(controlKey));
+	rb_define_const(HotKey, "COMMAND", INT2NUM(cmdKey));
+	rb_define_const(HotKey, "OPTION", INT2NUM(optionKey));
+
+	rb_define_alloc_func(HotKey, rhk_alloc);
+	rb_define_private_method(HotKey, "initialize", rhk_initialize, 2);
+	rb_define_method(HotKey, "register", rhk_register, 0);
+	rb_define_method(HotKey, "unregister", rhk_unregister, 0);
+}
+
+

data/lib/osx/hotkey.rb

@@ -0,0 +1,75 @@
+#!/usr/bin/ruby
+#
+
+require 'osx/cocoa'
+require 'osxhotkey.so'
+
+include OSX
+
+class OSX::NSApplicationWithHotKey < NSApplication
+
+	ns_override 'sendEvent:'
+
+	KEYMAP = {
+		"0" => 0x1D, "1" => 0x12, "2" => 0x13, "3" => 0x14,
+		"4" => 0x15, "5" => 0x17, "6" => 0x16, "7" => 0x1A,
+		"8" => 0x1C, "9" => 0x19, "A" => 0x00, "B" => 0x0B,
+		"C" => 0x08, "D" => 0x02, "E" => 0x0E, "F" => 0x03,
+		"G" => 0x05, "H" => 0x04, "I" => 0x22, "J" => 0x26,
+		"K" => 0x28, "L" => 0x25, "M" => 0x2E, "N" => 0x2D,
+		"O" => 0x1F, "P" => 0x23, "Q" => 0x0C, "R" => 0x0F,
+		"S" => 0x01, "T" => 0x11, "U" => 0x20, "V" => 0x09,
+		"W" => 0x0D, "X" => 0x07, "Y" => 0x10, "Z" => 0x06,
+	}
+
+	def sendEvent(event) # :nodoc:
+		if event.oc_type == 14 &&
+	       event.subtype == 6
+			@hotkey_procs ||= {}
+			if @hotkey_procs[event.data1]
+				@hotkey_procs[event.data1].call
+			end
+		end
+		super_sendEvent(event)
+	end
+
+	# This method register the _keys_ as global hotkey.
+	# And when the key is pressed, call the _block_. 
+	#
+	# _keys_ is caseinsensitive
+	def register_hotkey(keys, &block)
+		raise ArgumentError, "Require block." unless block_given?
+		mod = 0
+		key = nil
+		keys.split('+').each do |k|
+			k = k.upcase
+			case k
+			when 'SHIFT', 'CONTROL', 'COMMAND', 'OPTION'
+				mod |= HotKey.const_get(k)
+			else
+				if KEYMAP[k]
+					key = KEYMAP[k]
+				else
+					raise ArgumentError, "The Key #{k} is not in Map"
+				end
+			end
+		end
+		raise ArgumentError, "The Key is invalid" unless key
+		ref = HotKey.new(key, mod)
+		id = ref.register
+		@hotkey_procs ||= {}
+		@hotkey_procs[id] = block
+		ref
+	end
+end
+
+
+if $0 == __FILE__
+	app = NSApplicationWithHotKey.sharedApplication
+	ref = app.register_hotkey("command+shift+j") do
+		puts 'hello'
+	end
+
+	app.run
+end
+

data/test/osxhotkey_test.rb

@@ -0,0 +1,46 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class OsxhotkeyTest < Test::Unit::TestCase
+	def setup
+	end
+
+	def test_load
+		assert true
+	end
+
+	def test_keys
+		require 'thread'
+
+		q = SizedQueue.new(1)
+
+		app = NSApplicationWithHotKey.sharedApplication
+		assert_raise(ArgumentError) do
+			app.register_hotkey("") do
+			end
+		end
+
+		keytest = %w(
+			Command+Shift+T
+			Control+Option+T
+		)
+
+		keytest.each_with_index do |k,i|
+			app.register_hotkey(k) do
+				q << "OK#{i}"
+			end
+		end
+
+		Thread.start do
+			Thread.current.abort_on_exception = true
+
+			keytest.each_with_index do |k,i|
+				puts "Press #{k}"
+				assert_equal "OK#{i}", q.pop
+			end
+
+			app.stop(nil)
+		end
+
+		app.run
+	end
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/osx/hotkey'
+

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.9.0
+specification_version: 1
+name: osxhotkey
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+date: 2006-11-14 00:00:00 +09:00
+summary: HotKey integration with Ruby/Cocoa
+require_paths: 
+  - lib
+email: cho45@lowreal.net
+homepage: http://osxhotkey.rubyforge.org
+rubyforge_project: osxhotkey
+description: HotKey integration with Ruby/Cocoa
+autorequire: osx/hotkey
+default_executable: 
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+    - 
+      - ">"
+      - !ruby/object:Gem::Version 
+        version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+post_install_message: 
+authors: 
+  - cho45
+files: 
+  - README
+  - CHANGELOG
+  - Rakefile
+  - test/osxhotkey_test.rb
+  - test/test_helper.rb
+  - lib/osx
+  - lib/osx/hotkey.rb
+  - ext/osxhotkey.c
+  - ext/extconf.rb
+test_files: 
+  - test/test_helper.rb
+rdoc_options: 
+  - "--quiet"
+  - "--title"
+  - osxhotkey documentation
+  - "--opname"
+  - index.html
+  - "--line-numbers"
+  - "--main"
+  - README
+  - "--inline-source"
+  - "--exclude"
+  - "^(examples|extras)/"
+extra_rdoc_files: 
+  - README
+  - CHANGELOG
+executables: []
+extensions: 
+  - ext/extconf.rb
+requirements: []
+dependencies: []