simple_gui_creator 0.1.0

data/README

@@ -0,0 +1,70 @@
+This gem is meant to make GUI development in Ruby easy, and even fun.
+
+You can specify "easy window layout" in ASCII text, example, if you have a layout like this:
+
+---------- A Title ---------------------------
+| [a button:button1]   [button text:button2] |
+| "some text2:text1"                         |
+----------------------------------------------
+
+It will create a window that has buttons and text "like that," with reasonable spacing.
+
+Here's how:
+>> frame = ParseTemplate::JFramer.new # or optionally subclass this instead
+>> frame.parse_setup_filename 'some_filename'
+
+You can program behavior, like this:
+
+>> frame.elements['button1'].on_clicked { 
+  SimpleGui.show_blocking_message_dialog "you clicked button1!" 
+}  
+
+This has the effect of separating your view from your controller, in this case, because you can store the layouts in
+an entirely separate file, or embedded in the code.  "Normal humans" can edit the design layout files, for instance,
+and the separation allows for easy peace of mind.
+
+It also has helper methods for common GUI tasks, like the above show_blocking_message_dialog:
+
+SimpleGui.new_nonexisting_filechooser_and_go # select file or filename for a "new file" (not yet existing)
+SimpleGui.new_existing_dir_chooser_and_go # select pre-existing directory
+SimpleGui.show_in_explorer(filename) # reveals file in Explorer for windows, Finder for OS X
+text_from_user = SimpleGui.get_user_input "Input your name:" # these raise an exception if the user cancels the dialog,
+
+A select-button prompt dialog:
+
+if(SimpleGui.show_select_buttons_prompt("message title", :yes => 'text for the yes button', :no => 'text for the no button', :cancel => 'text for the cancel button') == :yes)
+  # they chose the "yes" equivalent button...
+end
+
+etc. ...
+
+It provies a few helper methods to the ParseTemplate::JFramer (and JFrame) class, like:
+
+#bring_to_front
+#minimize
+#restore
+#after_closed { ... }
+#after_minimized { ... }
+
+It has helpers to control/playback audio, like mp3's or wave's, starting/stopping asynchronously (see the files in the 'lib/ruby-easy-gui-creator' directory.
+It has helpers to set/get system clipboard contents.
+It has helpers to control/query the mouse (I use this, but don't know why anybody else ever would want to LOL).
+It has helpers to query the current system for its DVD drives, be notified when disks are inserted/changed, etc.
+
+Feedback/feature requests welcome.
+http://groups.google.com/group/roger-projects,  roger-projects@googlegroups.com
+I'd even be happy to wrap other gui frameworks (currently jruby/swing only) with the same helper functions, if anybody wanted it.
+
+Enjoy!
+
+To install/use:
+
+$ gem install simple-ruby-gui-creator
+
+>> require 'simple_gui'
+>> ... [see above]
+
+== Known problems ==
+
+Only allows single element types per line currently, like "all text" or "all buttons", but I'm working on it :)
+Only Jruby today, which can make loading time painful (hint: use splash screen).

data/Rakefile

@@ -0,0 +1,13 @@
+require 'sane'
+require 'jeweler2'
+Jeweler::Tasks.new do |gem|
+  gem.name = "simple_gui_creator"
+  gem.summary = %Q{Framework to ease in creation of ruby GUI apps. Makes designing windows a snap.}
+  gem.description = gem.summary # %Q{TODO: longer description of your gem}
+  gem.email = "rogerdpack@gmail.com"
+  gem.homepage = "http://github.com/rdp/simple-ruby-gui-creator"
+  gem.authors = ["rogerdpack"]
+  gem.add_dependency 'sane'
+end
+
+Jeweler::RubygemsDotOrgTasks.new

data/TODO

@@ -0,0 +1,4 @@
+on_minimized fix
+
+ask_should_allow_on_minimize {
+}

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/bin/simple_gui_creator

@@ -0,0 +1,88 @@
+#!/usr/bin/env ruby
+# assumes has rubygems loaded...since we need the sane gem
+require 'os'
+if !OS.jruby?
+  $stderr.puts 'jruby only for now, you can request a change to this, exiting...'
+  exit 1
+end
+require File.dirname(__FILE__) + "/../lib/simple_gui_creator.rb"
+
+class TestWindow < ParseTemplate::JFramer
+
+  def initialize
+    super
+    string = <<-EOL
+          ---------- Simple Ruby Gui Creator Test Window ---------------------------
+          | "Edit this, then..."                                                    |
+          | [Test it out! :create_button]                                           |
+          | [      :text_area_to_use, width=70chars, height=500, font=fixed_width]  |
+          | [                                                                    ]  |
+          | [                                                                    ]  |
+          | [                                                                    ]  |
+          | [                                                                    ]  |
+          | [                                                                    ]  |
+          | [                                                                    ]  |
+          | [                                                                    ]  |
+          |                                                                         |
+          | [Show code snippet :create_snippet]                                    |
+          --------------------------------------------------------------------------
+    EOL
+	Kernel.print string
+	parse_setup_string string
+	elements[:text_area_to_use].text=string
+    elements[:create_button].on_clicked {
+	  ParseTemplate::JFramer.new.parse_setup_string elements[:text_area_to_use].text
+	}
+	elements[:create_snippet].on_clicked {
+	  frame = ParseTemplate::JFramer.new.parse_setup_string elements[:text_area_to_use].text
+	  frame.close
+	  
+	  element_code = ""
+      frame.elements.each{|e| 
+        if e[1].is_a? Java::JavaxSwing::JButton
+	      element_code += "    elements[:#{e[0]}].on_clicked { puts 'clicked #{e[0]}' }\n"
+	    end
+      }	  
+	  
+      code=<<-EOL
+	  
+require 'simple-ruby-gui-creator.rb'
+
+class MyWindow < ParseTemplate::JFramer
+  def initialize
+    super
+    parse_setup_filename 'my_window.template' # create this file first
+	
+#{element_code}
+  end
+  
+end
+MyWindow.new
+	  EOL
+	  frame2 = ParseTemplate::JFramer.new.parse_setup_string <<-EOL
+        "Here's your snippet!"
+        [:code,width=500,height=400]
+        [                          ]
+        [                          ]
+        [Save Code Snippet:snippet_save]
+        "Here's your template:"
+        [:template_text,width=500,height=400,font=fixed_width]
+        [                                                    ]
+        [Save Template:template_save]
+	  EOL
+	  frame2.elements[:code].text = code
+	  frame2.elements[:snippet_save].on_clicked { save_file 'simple-gui-demo.rb', code}
+	  template = elements[:text_area_to_use].text
+	  frame2.elements[:template_text].text = template
+      frame2.elements[:template_save].on_clicked { save_file 'template.simple-gui-demo', template}
+	}
+  end
+  
+  def save_file default_filename, text
+    location = SimpleGuiCreator.new_nonexisting_or_existing_filechooser_and_go "Choose where to save:", nil, default_filename
+	File.write(location, text)
+  end
+
+end
+
+TestWindow.new

data/examples/absolute_positioning.rb

@@ -0,0 +1,12 @@
+require 'rubygems'
+require 'sane'
+require __DIR__ +  '/../lib/simple-ruby-gui-creator.rb'
+
+a = ParseTemplate::JFramer.new
+a.parse_setup_string <<EOL
+
+| [a button:button_name,width=100,height=100,abs_x=50,abs_y=50] [a third button]
+| [another button:button_name2] [another button:button_name4]|
+| [another button:button_name3] |
+
+EOL

data/lib/simple_gui_creator/drive_info.rb

@@ -0,0 +1,162 @@
+=begin
+Copyright 2010, Roger Pack 
+This file is part of Sensible Cinema.
+
+    Sensible Cinema is free software: you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    Sensible Cinema is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with Sensible Cinema.  If not, see <http://www.gnu.org/licenses/>.
+=end
+
+require 'os'
+require 'ostruct'
+require 'thread'
+
+class DriveInfo
+
+  def self.md5sum_disk(dir)
+   if OS.mac?
+     exe = "#{__DIR__}/../../vendor/mac_dvdid/bin/dvdid"
+   else
+     exe = "#{__DIR__}/../../vendor/dvdid.exe"
+   end
+   raise exe + '--exe doesnt exist?' unless File.exist? exe
+   command = "#{exe} \"#{dir}\""
+   output = `#{command}` # can take like 2.2s to spin up the disk...
+   raise 'dvdid command failed?' + command unless $?.exitstatus == 0
+   output.strip
+  end
+
+  @@drive_cache = nil
+  @@drive_cache_mutex = Mutex.new
+  @@drive_changed_notifies = []
+  def self.create_looping_drive_cacher
+    # has to be in its own thread or wmi will choke...
+    looped_at_least_once = false
+    if @caching_thread
+      looped_at_least_once = true
+    else
+      @caching_thread = Thread.new {
+        # use a dir glob to avoid having to use wmi too frequently (or accessing disks too often, which we might still be doing accidentally anyway)
+        if OS.doze?
+    		  old_drive_glob = '{' + DriveInfo.get_dvd_drives_even_if_no_disc_present.map{|dr| dr.MountPoint[0..0]}.join(',') + '}:/.' # must be in the thread for wmi
+        else
+          old_drive_glob = '/Volumes/*'
+        end
+        previously_known_about_discs = nil
+        loop {
+  	      should_update = false
+          @@drive_cache_mutex.synchronize { # in case the first update takes too long, basically, so they miss it LODO still a tiny race condition in here...might be useless...
+            looped_at_least_once = true # let the spawning waiting thread exit quickly
+            cur_disks = Dir[old_drive_glob]
+    		    if cur_disks != previously_known_about_discs
+  	          p 'updating disk lists...'
+  			      should_update = true
+              @@drive_cache = get_all_drives_as_ostructs_internal
+              previously_known_about_discs = cur_disks
+  		      end
+          }
+          notify_all_drive_blocks_that_change_has_occured if should_update
+          sleep 0.5
+        }
+      }
+    end
+    # maintain some thread startup sanity :P
+    while(!looped_at_least_once)
+      sleep 0.01
+    end
+    true
+  end
+
+  @@updating_mutex = Mutex.new # theoretically 2 threads could call this at once...so synchronize it...
+  def self.notify_all_drive_blocks_that_change_has_occured
+    @@updating_mutex.synchronize {
+      @@drive_changed_notifies.each{|block| block.call}
+    }
+  end
+
+ def self.add_notify_on_changed_disks &block
+  raise unless block
+  @@drive_changed_notifies << block
+  should_call = false
+  @@drive_cache_mutex.synchronize { should_call = true if @@drive_cache }
+  block.call if should_call # should be called at least once, right, on init?
+  true
+ end
+
+ def self.get_dvd_drives_as_openstruct
+   disks = get_all_drives_as_ostructs
+   disks.select{|d| d.Description =~ /CD-ROM/ && File.exist?(d.Name + "/VIDEO_TS")}
+ end
+ 
+  
+ def self.get_drive_with_most_space_with_slash
+  disks = get_all_drives_as_ostructs
+  most_space = disks.sort_by{|d| d.FreeSpace}[-1]
+  most_space.MountPoint + "/"
+ end
+
+ def self.get_all_drives_as_ostructs # gets all drives not just DVD drives...
+  @@drive_cache_mutex.synchronize {
+    if @caching_thread
+      @@drive_cache
+    else
+      get_all_drives_as_ostructs_internal # first time through for the startup thread goes here too
+    end
+  }
+ end
+
+ private
+
+ def self.get_dvd_drives_even_if_no_disc_present # private since it uses internal
+   raise unless OS.doze? # no idea how to do this in mac :P
+   disks = get_all_drives_as_ostructs_internal
+   disks.select{|d| d.Description =~ /CD-ROM/}
+ end
+
+  # DevicePoint is like "where to point mplayer at this succer"
+  def self.get_all_drives_as_ostructs_internal
+    if OS.mac?
+      require 'plist'
+      Dir['/Volumes/*'].map{|dir|
+       parsed = Plist.parse_xml(`diskutil info -plist "#{dir}"`)
+       d2 = OpenStruct.new
+       d2.VolumeName = parsed["VolumeName"]
+       d2.Name = dir # DevNode?
+       d2.FreeSpace = parsed["FreeSpace"].to_i
+       d2.Description = parsed['OpticalDeviceType']
+       d2.MountPoint = parsed['MountPoint']
+       if d2.MountPoint == '/'
+         # try to guess a more writable default location...this works I guess?
+         d2.MountPoint = File.expand_path '~'
+       end
+       d2.DevicePoint = parsed['DeviceNode'].sub('disk', 'rdisk') # I've heard using rdisk is better/faster...
+       d2
+      }
+    else
+      require 'ruby-wmi'
+      disks = WMI::Win32_LogicalDisk.find(:all)
+      disks.map{|d| d2 = OpenStruct.new
+        d2.Description = d.Description
+        d2.VolumeName = d.VolumeName
+        d2.Name = d.Name
+        d2.FreeSpace = d.FreeSpace.to_i
+        d2.MountPoint = d.Name[0..2] # like f:\
+        d2.DevicePoint = d2.MountPoint
+        d2
+      } 
+    end
+  end
+end
+
+if $0 == __FILE__
+  p DriveInfo.get_dvd_drives_as_openstruct
+end

data/lib/simple_gui_creator/mouse_control.rb

@@ -0,0 +1,149 @@
+=begin
+Copyright 2010, Roger Pack 
+This file is part of Sensible Cinema.
+
+    Sensible Cinema is free software: you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    Sensible Cinema is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with Sensible Cinema.  If not, see <http://www.gnu.org/licenses/>.
+=end
+require 'rubygems'
+require 'ffi'
+require 'java'
+
+module MouseControl
+  extend FFI::Library
+  MouseInfo =  java.awt.MouseInfo
+
+  ffi_lib 'user32'
+  ffi_convention :stdcall
+  
+  MOUSEEVENTF_MOVE = 1
+  INPUT_MOUSE = 0
+  MOUSEEVENTF_ABSOLUTE = 0x8000
+  MOUSEEVENTF_LEFTDOWN = 0x0002
+  MOUSEEVENTF_LEFTUP   = 0x0004
+  
+  
+  class MouseInput < FFI::Struct
+    layout :dx, :long,
+           :dy, :long,
+           :mouse_data, :ulong,
+           :flags, :ulong,
+           :time, :ulong,
+           :extra, :ulong
+  end
+  
+  class InputEvent < FFI::Union
+    layout :mi, MouseInput
+  end 
+  
+  class Input < FFI::Struct
+    layout :type, :ulong,
+           :evt, InputEvent
+  end
+  
+  # UINT SendInput(UINT nInputs, LPINPUT pInputs, int cbSize);
+  attach_function :SendInput, [ :uint, :pointer, :int ], :uint
+
+  # poller...
+  attach_function :GetAsyncKeyState, [:int], :uint
+  
+  class << self
+    
+    def jitter_forever_in_own_thread
+  
+      old_x, old_y = get_mouse_location
+      Thread.new {
+        loop {
+          move_y = 8 # just enough for VLC when full screened...
+          cur_x, cur_y = get_mouse_location
+          if(cur_x == old_x && cur_y == old_y)
+            @total_movements += 1
+            # blit it up
+            move_mouse_relative(0, move_y)
+            move_mouse_relative(0, move_y * -1)
+            # let it move it back
+            sleep 0.05
+            old_x, old_y = get_mouse_location
+            sleep 0.75
+          else
+            # user has been moving the mouse around, so we don't need to, to not annoy them
+            old_x, old_y = get_mouse_location
+            sleep 3
+          end
+        }
+      }
+      
+    end
+    
+    def move_mouse_relative dx, dy 
+      myinput = MouseControl::Input.new
+      myinput[:type] = MouseControl::INPUT_MOUSE
+      in_evt = myinput[:evt][:mi]
+      in_evt[:mouse_data] = 0 # null it out
+      in_evt[:flags] = MouseControl::MOUSEEVENTF_MOVE
+      in_evt[:time] = 0
+      in_evt[:extra] = 0
+      in_evt[:dx] = dx
+      in_evt[:dy] = dy
+      SendInput(1, myinput, MouseControl::Input.size)
+    end
+    
+    def single_click_left_mouse_button
+      left_mouse_down!
+      left_mouse_up!
+      p "CLICKED LEFT MOUSE BUTTON"
+    end
+    
+    def left_mouse_down!
+      send_left_mouse_button MOUSEEVENTF_LEFTDOWN
+    end
+    
+    def left_mouse_up!
+      send_left_mouse_button MOUSEEVENTF_LEFTUP
+    end
+
+    VK_LBUTTON = 0x01 # mouse left button for GetAsyncKeyState (seeing if mouse down currently or not)
+    
+    def left_mouse_button_state
+      GetAsyncKeyState(VK_LBUTTON) # ignore a first response, which also tells us if it has changed at all since last call
+      if GetAsyncKeyState(VK_LBUTTON) == 0 # zero means up
+        :up
+      else
+        :down
+      end
+    end
+    
+    # [x, y]
+    def get_mouse_location
+      loc = MouseInfo.getPointerInfo.getLocation # pure java!
+      [loc.x, loc.y]
+    end
+    
+    attr_accessor :total_movements
+    
+    private
+    
+    def send_left_mouse_button action_type
+      myinput = MouseControl::Input.new
+      myinput[:type] = MouseControl::INPUT_MOUSE
+      in_evt = myinput[:evt][:mi]
+      in_evt[:flags] = action_type
+      SendInput(1, myinput, MouseControl::Input.size)
+    end
+
+    
+  end
+    
+end
+
+MouseControl.total_movements=0 # ruby is a bit freaky with these...