wx_sugar 0.1.17 → 0.1.18

data/bin/xrcise

@@ -0,0 +1,128 @@
+# == Synopsis
+# 
+# xrc-tool : Generates ruby code from wxWidgets XML
+#
+# == Usage
+# 
+# xrc-tool [OPTIONS] <FILE>
+#
+# == Arguments
+#
+# <FILE> should be a valid XRC file from where class definitions are
+# extracted.
+# 
+# == Options
+#
+# -a, --appname [NAME]
+#    Create a basic Wx::App wrapper to run a frame. Not valid if more
+#    than one frame is identified in this file 
+#
+# -h, --help:
+#    Show this help
+#
+# -n, --namespace:
+#    Namespace module to wrap code in. If this is given, it  will be
+#    used both to prefix generated subclasses, and extend subclassed 
+#    controls contained in the windows.
+# 
+# -o, --output:
+#    Location for generated code. If this is a file, write all the
+#    generated classes to this one file. If this is a directory, writes
+#    each class as a separate file in it.
+#
+
+require 'wx_sugar/xrc'
+require 'getoptlong'
+require 'rdoc/ri/ri_paths' # avoid a bug in Ruby 1.8.5 with rdoc/usage
+require 'rdoc/usage'
+
+# Hacked version of RDoc::usage that allows it to accept an argument
+# specifying which file the usage comment source should be taken from;
+# the standard version defaults to the main program file, and when
+# installed via Rubygems, this points to the gem executable stub, which
+# has not-very-enlightening comments
+module RDoc
+  class << self
+    undef_method :usage
+    def usage(main_program_file = nil, exit_status = 0)
+      usage_no_exit(main_program_file)
+      exit(exit_status)
+    end
+
+    undef_method :usage_no_exit
+    def usage_no_exit(main_program_file = nil)
+      main_program_file ||= caller[-1].sub(/:\d+$/, '')
+      comment = File.open(main_program_file) do |file|
+        find_comment(file)
+      end
+      
+      comment = comment.gsub(/^\s*#/, '')
+      
+      markup = SM::SimpleMarkup.new
+      flow_convertor = SM::ToFlow.new
+      flow = markup.convert(comment, flow_convertor)
+      format = "plain"
+      
+      options = RI::Options.instance
+      if args = ENV["RI"]
+        options.parse(args.split)
+      end
+      formatter = options.formatter.new(options, "")
+      formatter.display_flow(flow)
+    end
+  end
+end
+
+# Back to the real program:
+opts = GetoptLong.new( [ '--appname', '-a', GetoptLong::OPTIONAL_ARGUMENT ],
+                       [ '--help', '-h', GetoptLong::NO_ARGUMENT ],
+                       [ '--namespace', '-n', GetoptLong::REQUIRED_ARGUMENT ],
+                       [ '--output', '-o', GetoptLong::REQUIRED_ARGUMENT ] )
+
+options  = {}
+output    = nil
+
+opts.each do | opt, arg |
+  case opt
+  when '--help'
+    RDoc::usage(__FILE__)
+  when '--appname'
+    options[:app_name] = ( arg.empty? ? 'MyApp' : arg )
+  when '--namespace'
+    options[:namespace] = arg
+  when '--output'
+    output = arg
+  end
+end
+
+if ARGV.empty?
+  puts "Missing FILE argument (try --help)"
+  exit 1
+end
+
+xrc_file = ARGV.shift
+
+
+resource = XRCResource.new(xrc_file)
+if output
+  # Write to separate files in output directory
+  if File.directory?(output)
+    resource.classes.each do | kls |
+      outfile = File.join(output, "#{kls.sub_class.downcase}.rb")
+      File.open(outfile, 'w') do | f |
+        Outputter.new(kls, options).output(f)
+      end
+    end
+  # Write all to one file
+  else
+    File.open(output, 'w') do | f | 
+      resource.classes.each do | kls | 
+        Outputter.new(kls, options).output(f)
+      end
+    end
+  end
+else
+  resource.classes.each do | kls | 
+    Outputter.new(kls, options).output
+  end
+end

data/lib/wx_sugar/delayed_constructors.rb

@@ -15,6 +15,10 @@ win_classes.flatten.each do | klass |
   # Returns a Proc object that when called with a single argument,
   # +parent+, will return a new widget constructed according to +args+ 
   def klass.[](*args)
+    # Deal with id parameter if none specified
+    if self.param_spec[0].name == :id and not args[0].kind_of?(Fixnum)
+      args.unshift(-1)
+    end
     lambda { | parent | new(parent, *args) }
   end
 

data/lib/wx_sugar/event_connector.rb

@@ -90,6 +90,7 @@ module EventConnector
   #  end
   #
   def listen(evt, source = self, handler = nil, &block)
+    warn "listen is deprecated, use evt_xxx directly (#{caller[0]})"
 
     # get the WxWidget evt_xxx method that will be called for binding
     event = "evt_#{evt}"

data/lib/wx_sugar/layout.rb

@@ -64,13 +64,15 @@ module Arranger
   def current_sizer()
     if @current_sizer
       return @current_sizer 
-    elsif sizer = self.get_sizer
-      return sizer
     else
-      @current_sizer = Wx::BoxSizer.new(Wx::VERTICAL)
-      self.set_sizer(@current_sizer)
-      @current_sizer
+      begin 
+        return self.get_sizer
+      rescue RuntimeError
+      end
     end
+    @current_sizer = Wx::BoxSizer.new(Wx::VERTICAL)
+    self.set_sizer(@current_sizer)
+    @current_sizer
   end
   
   # Set the main or current sizer of this container window to be

data/lib/wx_sugar/version.rb

@@ -1,3 +1,3 @@
 module WxSugar
-  VERSION = '0.1.17'
+  VERSION = '0.1.18'
 end

data/lib/wx_sugar/xrc/outputter.rb

@@ -0,0 +1,111 @@
+require 'erb'
+require 'ostruct'
+
+# Provides templated output of a Ruby subclass from an XRC specification
+# of a ruby Frame, Dialog or Panel class.
+class Outputter
+  # Valid options are :app_name and :module_name
+  attr_accessor :options, :klass
+
+  # Creates a new outputter from the XRCClass +xrc_class+
+  def initialize(xrc_class, options = {})
+    @klass = xrc_class
+    @options = options
+  end
+
+  # Writes the ruby code to the file or stream +io+
+  def output(io = $stdout)
+    tpl = ERB.new(TEMPLATE)
+    io.puts( tpl.result(binding) )
+  end
+
+  # Returns the fully-qualified (including module namespace prefix) for
+  # +name+.
+  def fq_name(name)
+    options[:namespace] ? "#{options[:namespace]}::#{name}" : name
+  end
+
+  # Returns the options object 
+  def opts
+    OpenStruct.new(options)
+  end
+
+  # Utility function to format the attr_readers line so it doesn't wrap
+  # in editors
+  def clean_id_attr_readers(str, start_len = 15, one_per_line = false)
+    new_string = ''
+    
+    if one_per_line
+      str.each(',') do | x |
+        new_string << x
+        new_string << "\n" + " " * (start_len-2)        
+      end
+    else      
+      wanted_length = 72
+      current_line_length = start_len
+      str.each(',') do |x|
+        if (current_line_length + x.length) > wanted_length
+          new_string << "\n" + " " * (start_len-2)
+          current_line_length = start_len
+        end
+        new_string << x
+        current_line_length += x.length      
+      end 
+    end
+    return new_string 
+  end
+end
+
+
+Outputter::TEMPLATE = <<'TEMPLATE'
+<% if opts.app_name %>
+require 'wx'
+<% if opts.namespace %>
+module <%= opts.namespace %>
+end
+<% end %><% end %>
+# This class was automatically generated from XRC source. It is not
+# recommended that this file is edited directly; instead, inherit from
+# this class and extend its behaviour there.  
+#
+# Source file: <%= klass.file_name %> 
+# Generated at: <%= Time.now %>
+
+class <%= fq_name(klass.sub_class) %> < <%= klass.superclass %>
+  <% if not klass.controls.empty? %><% ids = klass.controls.map { | ctrl | ":#{ctrl.name.downcase}" }.join(', ') %>
+  attr_reader <%= clean_id_attr_readers(ids) %>
+  <% end %>
+  def initialize(parent = nil)
+    super()
+    xml = Wx::XmlResource.get
+    xml.flags = 2 # Wx::XRC_NO_SUBCLASSING
+    xml.init_all_handlers
+    xml.load("<%= klass.file_name %>")
+    xml.<%= klass.load_func %>(self, parent, "<%= klass.base_id %>")
+
+    finder = lambda do | x | 
+      int_id = Wx::xrcid(x)
+      begin
+        Wx::Window.find_window_by_id(int_id, self) || int_id
+      # Temporary hack to work around regression in 1.9.2; remove
+      # begin/rescue clause in later versions
+      rescue RuntimeError
+        int_id
+      end
+    end
+    <% klass.controls.each do | ctrl | %>
+    @<%= ctrl.name.downcase %> = finder.call("<%= ctrl.name %>")<% if ctrl.sub_class %>
+    @<%= ctrl.name.downcase %>.extend(<%= fq_name(ctrl.sub_class) %>)<% end %><% end %>
+  end
+end
+
+<% if opts.app_name %>
+class <%= opts.app_name %> < Wx::App
+  def on_init
+    f =  <%= opts.module_name %>::<%= fq_name(klass.sub_class) %>.new
+    f.show
+  end
+end
+<%= opts.app_name %>.new.main_loop
+<% end %>
+TEMPLATE

data/lib/wx_sugar/xrc/xml_class.rb

@@ -0,0 +1,74 @@
+# Representation of a single GUI class defined in XRC. wxRuby permits
+# subclasses of Frames, Dialog and Panels to be loaded from XRC. 
+class XRCClass
+  # Only these classes may be subclassed in Ruby
+  VALID_CLASSES = %|wxFrame wxDialog wxPanel|
+
+  # Simple struct to hold details of a individual named control
+  Control = Struct.new(:name, :sub_class)
+
+  # base_id   : the Wx identifier of the main window
+  # wx_class  : the Wx class which this window inherits from
+  # sub_class : the ruby class name of this window class
+  # controls  : an array of identified controls within this window
+  # file_name : the XRC file from which this class can be loaded
+  attr_reader :base_id, :wx_class, :sub_class, :controls, :file_name
+  
+  # Checks to see if a valid class can be created from +xml_elem+, and
+  # returns one if it can, or nil if it can't. To be a valid class, the
+  # window must inherit from Frame, Dialog or Window, and must define a
+  # subclass name.
+  def self.extract(xml_elem, xrc_file)
+    p_class = xml_elem.attributes['class']
+    if not VALID_CLASSES.include?(p_class)
+      warn "Cannot create wrapper for subclass of #{p_class}"
+      return 
+    end
+
+    if not xml_elem.attributes['subclass']
+      warn "Cannot create wrapper for class without 'subclass'
+      attribute"
+      return
+    end
+    new(xml_elem, xrc_file)
+  end
+
+  # Create a new class from +xml_elem+
+  def initialize(xml_elem, xrc_file)
+    @xml_src   = xml_elem
+    @file_name = xrc_file
+
+    @base_id   = xml_elem.attributes['name']
+    @wx_class  = xml_elem.attributes['class']
+    @sub_class = xml_elem.attributes['subclass']
+    @controls  = []
+    read_controls
+  end
+
+  def superclass
+    wx_class.sub(/^wx/, "Wx::")
+  end
+
+  def load_func
+    unadorned = wx_class.sub(/^wx/, '').downcase
+    "load_#{unadorned}_subclass"
+  end
+
+  private
+  # Scans the XRC definition of this class for named contained
+  # controls. Controls which are given a non-default name in the RAD
+  # tool are picked up, and will be given attribute readers in the Ruby
+  # class. Additionally, if a "subclass" attribute is specified for the
+  # control, the Ruby control will be extended with that class. 
+  def read_controls
+    finder = "/resource/object[@name='#{base_id}']//*[@name]"
+    REXML::XPath.each(@xml_src, finder) do | elem |
+      ctrl_name = elem.attributes['name']
+      # skip default names
+      next if ctrl_name =~ /^wx/
+      next if ctrl_name =~ /^ID_/
+      ctrl_subclass = elem.attributes['subclass']
+      @controls << Control.new(ctrl_name, ctrl_subclass)
+    end
+  end
+end

data/lib/wx_sugar/xrc/xml_resource.rb

@@ -0,0 +1,19 @@
+require 'rexml/document'
+# Parser for a complete wxWidgets XRC file. XRC files may contain one
+# or more definitions of Wx Frames, Dialogs or Panels.
+class XRCResource
+  attr_reader :xrc_file, :classes
+
+  # Read and seek for classes within the XML file +xrc_file+
+  def initialize(xrc_file)
+    @xrc_file = xrc_file
+    xml_content = File.read(xrc_file)
+    @xml_doc = REXML::Document.new(xml_content)
+    @classes = []
+    REXML::XPath.each(@xml_doc.root, "/resource/object") do | elem |
+      if xml_klass = XRCClass.extract(elem, @xrc_file)
+        @classes << xml_klass
+      end
+    end
+  end
+end

data/lib/wx_sugar/xrc.rb

@@ -0,0 +1,8 @@
+# Tools for working with XRC via the xrcise script utility. These
+# libraries are not intended to be used within an application; rather,
+# they provide a framework for extracting class definitions from
+# wxWidgets XML format, XRC, and creating ruby code that loads that XRC 
+
+require 'wx_sugar/xrc/xml_resource'
+require 'wx_sugar/xrc/xml_class'
+require 'wx_sugar/xrc/outputter'

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.0
 specification_version: 1
 name: wx_sugar
 version: !ruby/object:Gem::Version 
-  version: 0.1.17
-date: 2007-09-11 00:00:00 +01:00
+  version: 0.1.18
+date: 2007-10-23 00:00:00 +01:00
 summary: Syntax extensions for WxRuby.
 require_paths: 
 - lib
@@ -29,9 +29,11 @@ post_install_message:
 authors: 
 - Alex Fenton
 files: 
+- bin/xrcise
 - lib/wx_sugar
 - lib/wx_sugar.rb
 - lib/wx_sugar/wx_classes
+- lib/wx_sugar/xrc
 - lib/wx_sugar/layout.rb
 - lib/wx_sugar/delayed_constructors.rb
 - lib/wx_sugar/class_definitions.rb
@@ -41,6 +43,7 @@ files:
 - lib/wx_sugar/itemdata.rb
 - lib/wx_sugar/event_connector.rb
 - lib/wx_sugar/wx_classes.rb
+- lib/wx_sugar/xrc.rb
 - lib/wx_sugar/version.rb
 - lib/wx_sugar/wx_classes/listctrl.rb
 - lib/wx_sugar/wx_classes/colour.rb
@@ -48,6 +51,9 @@ files:
 - lib/wx_sugar/wx_classes/window.rb
 - lib/wx_sugar/wx_classes/size.rb
 - lib/wx_sugar/wx_classes/control_with_items.rb
+- lib/wx_sugar/xrc/xml_class.rb
+- lib/wx_sugar/xrc/xml_resource.rb
+- lib/wx_sugar/xrc/outputter.rb
 - samples/sugar-sample.rb
 - LICENCE
 test_files: []
@@ -56,8 +62,8 @@ rdoc_options: []
 
 extra_rdoc_files: []
 
-executables: []
-
+executables: 
+- xrcise
 extensions: []
 
 requirements: []