rum 0.0.1-universal-darwin-10 → 0.0.3-universal-darwin-10

data/doc/example.rb

@@ -32,7 +32,7 @@ type '(ctrl (shift a))' # Key combinations
 # 5. Help and introspection
 # Prompts you to enter a hotkey and then jumps to its
 # definition in your text editor.
-'shift f2'.do { Rum.show_hotkey }
+'shift f2'.do { Rum.visit_hotkey }
 
 # Asks you to enter an arbitrary hotkey and inserts a hotkey
 # definition snippet.

data/doc/reference.rb

@@ -33,7 +33,7 @@ layout['foo']  #=> #<Key:foo>
 
 ## Finding out the name of a key
 # All keyboard activity is reported at the terminal.
-# Switch to the Rum terminal window and press a key. 
+# Switch to the Rum terminal window and press a key.
 
 
 ### Advanced
@@ -58,7 +58,7 @@ layout.core_modifier 'escape' # Sets a core modifier.
 
 
 
-#### 2. Hotkeys
+#### 3. Hotkeys
 ## The basics
 'modifiers hotkey'.do { action }
 'ctrl shift w'.do { active_window.close }
@@ -129,7 +129,7 @@ action = 'ctrl a'.unregister
 
 
 
-#### 3. Keyboard
+#### 4. Keyboard
 
 ### Caveat: Not yet available on the Mac.
 
@@ -177,6 +177,9 @@ type '(keydown a)'
 # Provide the :blind flag to bypass auto-releasing
 'ctrl a'.do { type 'w', :blind } # 'ctrl' might still be pressed when 'w' is sent.
 
+## Windows-specific: Unicode input
+# Sends unicode input. Supports the key combination syntax from 'type'.
+type_unicode '۩—↑ (ctrl ۞)'
 
 ## Windows-specific: Extended keys
 # Sends 'alt' with the 'extended' flag set.
@@ -184,7 +187,7 @@ type '(alt-extended)'
 
 
 
-#### 3. Gui
+#### 5. Gui
 ## Messages
 # Prints a non-disruptive notification when Growl is enabled,
 # falls back to alert (see below)  otherwise
@@ -239,13 +242,13 @@ Gui.read
 ...
 
 
-#### 4. Get selected text
+#### 6. Get selected text
 ### Caveat: Not yet available on the Mac.
 # Grabs the currently selected text.
 get_selection # returns the current selection or nil
 
 
-#### 5. Clipboard
+#### 7. Clipboard
 ### Caveat: Not yet available on the Mac.
 # Retrieves the clipboard contents as text.
 Clipboard.get # Always returns a string
@@ -272,7 +275,7 @@ Clipboard.preserve { Clipboard.set 'bar' }
 Clipboard.get #=> "foo"
 
 
-#### 6. More methods
+#### 8. More methods
 ## Waiting
 # Wait until condition is true. Times out after 5 seconds, updates every 0.01 seconds.
 wait { condition } #=> False when timed-out. Otherwise: true
@@ -302,14 +305,14 @@ System.spawn_in_terminal
 System.start
 System.applescript
 
-#### 6. Rum's threading model
+#### 9. Rum's threading model
 # Rum employs one worker thread that executes all hotkey actions
 # sequentially.
 # Errors during execution are automatically reported via Gui.message.
 
 # If you have a long running action that may run in parallel with
 # other actions call 'Rum.switch_worker_thread'. Action execution is
-# then resumed on another thread.
+# then resumed in another thread.
 'ctrl a'.do { Rum.switch_worker_thread; long_running_stuff }
 
 # The following is also possible...
@@ -320,10 +323,10 @@ System.applescript
 # When you call Gui.read, Gui.alert or Gui.print
 # then Rum.switch_worker_thread is automatically run.
 
-#### 5. Help, introspection
+#### 10. Help, introspection
 # Prompts you to enter a hotkey and then jumps to its
 # definition via Gui.open_file.
-Rum.show_hotkey
+Rum.visit_hotkey
 # (Requires you to register your text-editor, see Gui.open_file above.)
 
 # Asks you to enter an arbitrary hotkey and inserts a hotkey
@@ -342,16 +345,16 @@ WindowInfo.start
 Rum.reference
 
 
-#### 5. Restarting, server
+#### 11. Restarting, server
 # Restart the current Rum configuration.
-Rum.restart 
+Rum.restart
 
 # Start the server. This allows for connections to the
 # Rum process via rum-client.
 Rum::Server.start
 
 
-#### 6. Windows
+#### 12. Windows
 
 ### Caveat: Not yet available on the Mac.
 
@@ -388,8 +391,19 @@ w.class_name #=> "Chrome_WidgetWin_0"
 w.close
 w.kill_task # kills the task associated with the window
 
+## Child windows
+# Enumerate all child windows
+w = active_window
+w.child_windows { |child| puts child.class_name }
+w.child_windows # => #<Enumerator: ...>
 
-#### 7. Apps
+# Get child window by class name. Pattern can be a regex or a string (for exact matches).
+w.child_window(pattern)
+
+# Example: Activate Evernote's search field
+Evernote.window.child_window('ENAutoCompleteEditCtrl').show
+
+#### 13. Apps
 # Integrates prominent applications into Rum.
 require 'rum/apps'
 
@@ -412,4 +426,3 @@ Emacs.eval '(idle-highlight-mode t)' # Turns on a minor mode in the current buff
 # Set this on Windows to allow Emacs.activate
 # to start Emacs when it's not running.
 Emacs.path = 'path/to/runemacs'
- 

data/doc/resources/build.rb

@@ -1,14 +1,17 @@
 require 'haml'
 
+Encoding.default_external = Encoding::UTF_8
+
 class Doc
   module Pygmentize
     Bin = if RUBY_PLATFORM =~ /mswin|mingw/ and ENV['USER'] == 'nonsequitur'
-            'C:/Programme/Python26/Scripts/pygmentize.exe'
+            python_dir = File.expand_path('~/vendor/Python32')
+            "#{python_dir}/python.exe #{python_dir}/scripts/pygmentize"
           else
             'pygmentize'
           end
-    Cmd = "#{Bin} -O encoding=utf-8 -l ruby -f html"
-    
+    Cmd = "#{Bin} -l ruby -f html"
+
     def self.file file
       fix_pygments_output(`#{Cmd} #{file}`)
     end
@@ -22,9 +25,8 @@ class Doc
     end
 
     def self.fix_pygments_output str
-      # Bug in Pygments 1.3.1: 'type' is no Ruby builtin
-      str.gsub('<span class="nb">type</span>', 'type')\
-         .gsub('<span class="nb">require</span>', 'require')
+      # Don't highlight 'require'
+      str.gsub('<span class="nb">require</span>', 'require')
     end
 
     class Snippets
@@ -63,7 +65,7 @@ class Doc
       parse
       to_html
     end
-    
+
     def parse
       @result = []
       @last_type = nil
@@ -81,7 +83,7 @@ class Doc
       else [:code, line]
       end
     end
-    
+
     EmptyAllowed = { code: true, text: true }
 
     def compose_doc type, line
@@ -97,7 +99,7 @@ class Doc
 
     class TableOfContents
       Heading = Struct.new(:text, :anchor_name)
-      
+
       def initialize
         @headings = []
       end
@@ -106,7 +108,7 @@ class Doc
         chapter_number = @headings.count + 1
         @headings << Heading.new(heading, "chapter_#{chapter_number}")
       end
-    
+
       def heading_html
         heading = @headings.last
         "<a name=\"#{heading.anchor_name}\"><h1>#{heading.text}</h1></a>"
@@ -133,7 +135,7 @@ class Doc
     def to_html
       snippets = Pygmentize::Snippets.new
       table_of_contents = TableOfContents.new
-      
+
       sections = @result.map do |type, *lines|
         case type
         when :chapter
@@ -225,7 +227,7 @@ EOF
   end
 
   def save
-    File.open(@output, 'w') { |f| f.write @doc }
+    File.open(@output, 'wb') { |f| f.write @doc }
   end
 
   def build

data/doc/resources/doc.haml

@@ -6,7 +6,12 @@
     %link(rel="stylesheet" href="resources/highlight.css" type="text/css" media="screen")
 
   %body
-    %img{id: "logo", src: "resources/logo.png"}
+    %a{href: "#"}
+      %img{id: "logo", src: "resources/logo.png"}
+    %a{href: "https://github.com/nonsequitur/rum"}
+      %img{style: "position: absolute; top: 0; right: 0; border: 0;",
+           src: "https://s3.amazonaws.com/github/ribbons/forkme_right_red_aa0000.png",
+           alt:"Fork me on GitHub"}
     #nav
       %ul
         %li
@@ -22,7 +27,7 @@
         %li
           %a{href: "#development"} Development
     #wrapper
-      #intro Rum is a cross-platform Hotkey and Macro utility, built in Ruby.<br />Not yet running on Linux, it’s progressing steadily on the Mac (MacRuby) and is fully supported on Windows.
+      #intro Rum is a cross-platform Hotkey and Macro utility, built in Ruby.<br />It runs on Windows and Mac OS.
 
       %img{src: "resources/screenshot.png"}
       #screenshot-sub
@@ -56,7 +61,7 @@
           #platforms
             %h3 Supported platforms
             %ul
-              %li Mac OS X – MacRuby >=0.10
+              %li Mac OS X >= 10.7 – MacRuby >=0.10.<br />
               %li
                 32-bit Windows XP/Vista/7 – Ruby >=1.9.1p378.<br />
           #growl

data/ext/mac/keyboard_hook/EventTap.h

@@ -5,7 +5,7 @@
 	id delegate;
 }
 -(id)init;
--(Event*)handleEvent:(Event*)event;
+-(Event*)handleKeyEvent:(Event*)event;
 @end
 
 CGEventRef eventCallback(CGEventTapProxy proxy, CGEventType type, CGEventRef event, void *eventTapObject);

data/ext/mac/keyboard_hook/EventTap.m

@@ -22,18 +22,18 @@ CFMachPortRef keyboard_event_tap;
 -(id)init {
 	[super init];
 	keyboard_event_tap = CGEventTapCreate(kCGHIDEventTap,
-                                              kCGHeadInsertEventTap,
-                                              kCGEventTapOptionDefault,
-                                              CGEventMaskBit(kCGEventKeyDown) | CGEventMaskBit(kCGEventKeyUp) | CGEventMaskBit(kCGEventFlagsChanged),
-                                              &eventCallback,
-                                              self);
+                                          kCGHeadInsertEventTap,
+                                          kCGEventTapOptionDefault,
+                                          CGEventMaskBit(kCGEventKeyDown) | CGEventMaskBit(kCGEventKeyUp) | CGEventMaskBit(kCGEventFlagsChanged),
+                                          &eventCallback,
+                                          self);
 	CFRunLoopSourceRef tapSource = CFMachPortCreateRunLoopSource(NULL, keyboard_event_tap, 0);
 	CFRunLoopAddSource((CFRunLoopRef) [[NSRunLoop currentRunLoop] getCFRunLoop], tapSource, kCFRunLoopCommonModes);
-	
+
 	return self;
 }
 
--(Event*)handleEvent:(Event*)event {
+-(Event*)handleKeyEvent:(Event*)event {
 	// to be overridden by ruby code
 	return event;
 }
@@ -72,6 +72,6 @@ CGEventRef eventCallback(CGEventTapProxy proxy, CGEventType type,
   default:
     return event;
   }
-  
-  return [((id) eventTapObject) handleEvent:[[Event alloc] initWithEventRef:event tapProxy:proxy type:type down:is_down]].eventRef;
+
+  return [((id) eventTapObject) handleKeyEvent:[[Event alloc] initWithEventRef:event tapProxy:proxy type:type down:is_down]].eventRef;
 }

data/ext/mac/keyboard_hook/KeyboardHook.xcodeproj/project.pbxproj

@@ -3,7 +3,7 @@
 	archiveVersion = 1;
 	classes = {
 	};
-	objectVersion = 45;
+	objectVersion = 46;
 	objects = {
 
 /* Begin PBXBuildFile section */
@@ -169,8 +169,12 @@
 		0867D690FE84028FC02AAC07 /* Project object */ = {
 			isa = PBXProject;
 			buildConfigurationList = 1DEB91B108733DA50010E9CD /* Build configuration list for PBXProject "KeyboardHook" */;
-			compatibilityVersion = "Xcode 3.1";
+			compatibilityVersion = "Xcode 3.2";
+			developmentRegion = English;
 			hasScannedForEncodings = 1;
+			knownRegions = (
+				en,
+			);
 			mainGroup = 0867D691FE84028FC02AAC07 /* KeyboardHook */;
 			productRefGroup = 034768DFFF38A50411DB9C8B /* Products */;
 			projectDirPath = "";
@@ -220,17 +224,17 @@
 			isa = XCBuildConfiguration;
 			buildSettings = {
 				ALWAYS_SEARCH_USER_PATHS = NO;
+				COMBINE_HIDPI_IMAGES = YES;
 				COPY_PHASE_STRIP = NO;
 				DYLIB_COMPATIBILITY_VERSION = 1;
 				DYLIB_CURRENT_VERSION = 1;
 				FRAMEWORK_SEARCH_PATHS = (
 					"$(inherited)",
-					"\"$(SRCROOT)/../../DDHidLib-1.1/build/Release\"",
 					"\"$(SRCROOT)/..\"",
+					/Library/Frameworks,
 				);
 				FRAMEWORK_VERSION = A;
 				GCC_DYNAMIC_NO_PIC = NO;
-				GCC_ENABLE_FIX_AND_CONTINUE = YES;
 				GCC_MODEL_TUNING = G5;
 				GCC_OPTIMIZATION_LEVEL = 0;
 				GCC_PRECOMPILE_PREFIX_HEADER = YES;
@@ -246,14 +250,15 @@
 			isa = XCBuildConfiguration;
 			buildSettings = {
 				ALWAYS_SEARCH_USER_PATHS = NO;
+				COMBINE_HIDPI_IMAGES = YES;
 				DEBUG_INFORMATION_FORMAT = "dwarf-with-dsym";
 				DYLIB_COMPATIBILITY_VERSION = 1;
 				DYLIB_CURRENT_VERSION = 1;
 				EXECUTABLE_EXTENSION = bundle;
 				FRAMEWORK_SEARCH_PATHS = (
 					"$(inherited)",
-					"\"$(SRCROOT)/../../DDHidLib-1.1/build/Release\"",
 					"\"$(SRCROOT)/..\"",
+					/Library/Frameworks,
 				);
 				FRAMEWORK_VERSION = A;
 				GCC_ENABLE_OBJC_GC = supported;
@@ -277,8 +282,7 @@
 				GCC_WARN_ABOUT_RETURN_TYPE = YES;
 				GCC_WARN_UNUSED_VARIABLE = YES;
 				ONLY_ACTIVE_ARCH = YES;
-				PREBINDING = NO;
-				SDKROOT = macosx10.5;
+				SDKROOT = macosx10.7;
 			};
 			name = Debug;
 		};
@@ -291,8 +295,7 @@
 				GCC_WARN_ABOUT_RETURN_TYPE = YES;
 				GCC_WARN_UNUSED_VARIABLE = YES;
 				ONLY_ACTIVE_ARCH = YES;
-				PREBINDING = NO;
-				SDKROOT = macosx10.5;
+				SDKROOT = macosx10.7;
 			};
 			name = Release;
 		};

data/ext/windows/keyboard_hook/keyboard_hook.c

@@ -22,7 +22,7 @@ static BOOL pass_key_event_to_ruby(struct KeyEvent *key_event) {
                                INT2NUM(key_event->scancode),
                                (key_event->down ? Qtrue : Qfalse) };
   VALUE event = rb_class_new_instance(3, event_attributes, cEvent);
-  
+
   return (Qtrue == rb_funcall(ruby_callback_proc, id_call, 1, event));
 }
 
@@ -36,7 +36,7 @@ callback_function(int Code, WPARAM wParam, LPARAM lParam)
   #ifdef DEBUG
   puts("Enter Callback");
   #endif
-  
+
   key_event.vkcode   = kbd->vkCode;
   key_event.scancode = kbd->scanCode;
   key_event.down     = (wParam == WM_KEYDOWN || wParam == WM_SYSKEYDOWN);
@@ -96,7 +96,7 @@ static VALUE start(int argc, VALUE* argv, VALUE self)
     HMODULE module = GetModuleHandle(NULL);
     thread = GetCurrentThreadId();
     rb_scan_args(argc, argv, "0&", &ruby_callback_proc);
-    
+
     keyboard_hook = SetWindowsHookEx(WH_KEYBOARD_LL, (HOOKPROC)callback_function,
                                      module, 0);
     rb_thread_blocking_region(pump_messages, 0, 0, 0);

data/ext/windows/system/autohotkey_stuff.c

@@ -1,10 +1,15 @@
 #include <windows.h>
 
-DWORD g_MainThreadID;
+static DWORD g_MainThreadID;
 
 void autohotkey_stuff_initialize(DWORD main_thread_id)
 {
-  g_MainThreadID = main_thread_id; 
+  g_MainThreadID = main_thread_id;
+}
+
+static void key_down_up(BYTE vkcode) {
+    keybd_event(vkcode, 0, 0, 0);
+    keybd_event(vkcode, 0, KEYEVENTF_KEYUP, 0);
 }
 
 HWND AttemptSetForeground(HWND aTargetWindow, HWND aForeWindow)
@@ -80,9 +85,9 @@ HWND SetForegroundWindowEx(HWND aTargetWindow)
   else
     show_mode = SW_SHOW;
   ShowWindow(aTargetWindow, show_mode);
-  
-  
-  
+
+
+
   // if (g_os.IsWin95() || (!g_os.IsWin9x() && !g_os.IsWin2000orLater())))  // Win95 or NT
   // Try a simple approach first for these two OS's, since they don't have
   // any restrictions on focus stealing:
@@ -199,10 +204,8 @@ HWND SetForegroundWindowEx(HWND aTargetWindow)
       // but later, after the hotkey is released, it can be.  So perhaps this is being
       // caused by the fact that the user has keys held down (logically or physically?)
       // Releasing those keys with a key-up event might help, so try that sometime:
-      /* Remarks from Rum: The following two lines are disabled since KeyEvent
-         is not implemented: */
-      /* KeyEvent(KEYDOWNANDUP, VK_MENU); */
-      /* KeyEvent(KEYDOWNANDUP, VK_MENU); */
+        key_down_up(VK_LMENU);
+        key_down_up(VK_LMENU);
       //KeyEvent(KEYDOWN, VK_LWIN)                    ;
       //KeyEvent(KEYDOWN, VK_TAB)                     ;
       //KeyEvent(KEYUP, VK_TAB)                       ;
@@ -252,4 +255,3 @@ HWND SetForegroundWindowEx(HWND aTargetWindow)
   else
     return NULL                             ;
 }
-