Class: Outputter

Inherits:
Object
  • Object
show all
Defined in:
lib/wx_sugar/xrc/outputter.rb

Overview

Provides templated output of a Ruby subclass from an XRC specification of a ruby Frame, Dialog or Panel class.

Constant Summary collapse

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(xrc_class, options = {}) ⇒ Outputter

Creates a new outputter from the XRCClass xrc_class



11
12
13
14
 
# File 'lib/wx_sugar/xrc/outputter.rb', line 11

def initialize(xrc_class, options = {})
  @klass = xrc_class
  @options = options
end

Instance Attribute Details

#klass ⇒ Object

Valid options are :app_name and :module_name



8
9
10
 
# File 'lib/wx_sugar/xrc/outputter.rb', line 8

def klass
  @klass
end

#options ⇒ Object

Valid options are :app_name and :module_name



8
9
10
 
# File 'lib/wx_sugar/xrc/outputter.rb', line 8

def options
  @options
end

Instance Method Details

#clean_id_attr_readers(str, start_len = 15, one_per_line = false) ⇒ Object

Utility function to format the attr_readers line so it doesn’t wrap in editors



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/wx_sugar/xrc/outputter.rb', line 35

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

#fq_name(name) ⇒ Object

Returns the fully-qualified (including module namespace prefix) for name.



24
25
26
 
# File 'lib/wx_sugar/xrc/outputter.rb', line 24

def fq_name(name)
  options[:namespace] ? "#{options[:namespace]}::#{name}" : name
end

#opts ⇒ Object

Returns the options object



29
30
31
 
# File 'lib/wx_sugar/xrc/outputter.rb', line 29

def opts
  OpenStruct.new(options)
end

#output(io = $stdout) ⇒ Object

Writes the ruby code to the file or stream io



17
18
19
20
 
# File 'lib/wx_sugar/xrc/outputter.rb', line 17

def output(io = $stdout)
  tpl = ERB.new(TEMPLATE)
  io.puts( tpl.result(binding) )
end