Module: Glimmer::LibUI::CustomControl
- Includes:
- DataBinding::ObservableModel, SuperModule
- Included in:
- CodeArea, CustomWindow
- Defined in:
- lib/glimmer/libui/custom_control.rb
Instance Attribute Summary collapse
Class Method Summary
collapse
Instance Method Summary
collapse
Dynamic Method Handling
This class handles dynamic methods through the method_missing method
#method_missing(method_name, *args, &block) ⇒ Object
224
225
226
227
228
229
230
231
232
|
# File 'lib/glimmer/libui/custom_control.rb', line 224
def method_missing(method_name, *args, &block)
if block && can_handle_listener?(method_name)
handle_listener(method_name, &block)
else
@body_root.send(method_name, *args, &block)
end
end
|
Instance Attribute Details
#args ⇒ Object
Returns the value of attribute args.
165
166
167
|
# File 'lib/glimmer/libui/custom_control.rb', line 165
def args
@args
end
|
#body_root ⇒ Object
Returns the value of attribute body_root.
165
166
167
|
# File 'lib/glimmer/libui/custom_control.rb', line 165
def body_root
@body_root
end
|
#content(&block) ⇒ Object
Returns content block if used as an attribute reader (no args) Otherwise, if a block is passed, it adds it as content to this custom control
216
217
218
|
# File 'lib/glimmer/libui/custom_control.rb', line 216
def content
@content
end
|
#keyword ⇒ Object
Returns the value of attribute keyword.
165
166
167
|
# File 'lib/glimmer/libui/custom_control.rb', line 165
def keyword
@keyword
end
|
#libui ⇒ Object
Returns the value of attribute libui.
165
166
167
|
# File 'lib/glimmer/libui/custom_control.rb', line 165
def libui
@libui
end
|
#options ⇒ Object
Returns the value of attribute options.
165
166
167
|
# File 'lib/glimmer/libui/custom_control.rb', line 165
def options
@options
end
|
#parent ⇒ Object
Returns the value of attribute parent.
165
166
167
|
# File 'lib/glimmer/libui/custom_control.rb', line 165
def parent
@parent
end
|
#parent_proxy ⇒ Object
Returns the value of attribute parent_proxy.
165
166
167
|
# File 'lib/glimmer/libui/custom_control.rb', line 165
def parent_proxy
@parent_proxy
end
|
Class Method Details
.add_custom_control_namespaces_for(klass) ⇒ Object
.after_body(&block) ⇒ Object
160
161
162
|
# File 'lib/glimmer/libui/custom_control.rb', line 160
def after_body(&block)
@after_body_block = block
end
|
.before_body(&block) ⇒ Object
152
153
154
|
# File 'lib/glimmer/libui/custom_control.rb', line 152
def before_body(&block)
@before_body_block = block
end
|
.body(&block) ⇒ Object
156
157
158
|
# File 'lib/glimmer/libui/custom_control.rb', line 156
def body(&block)
@body_block = block
end
|
.custom_control_namespaces ⇒ Object
106
107
108
|
# File 'lib/glimmer/libui/custom_control.rb', line 106
def custom_control_namespaces
@custom_control_namespaces ||= reset_custom_control_namespaces
end
|
.def_option_attr_accessors(new_options) ⇒ Object
138
139
140
141
142
143
144
145
146
147
148
149
150
|
# File 'lib/glimmer/libui/custom_control.rb', line 138
def def_option_attr_accessors(new_options)
new_options.each do |option, default|
class_eval <<-end_eval, __FILE__, __LINE__
def #{option}
options[:#{option}]
end
def #{option}=(option_value)
self.options[:#{option}] = option_value
end
end_eval
end
end
|
.flyweight_custom_control_classes ⇒ Object
Flyweight Design Pattern memoization cache. Can be cleared if memory is needed.
78
79
80
|
# File 'lib/glimmer/libui/custom_control.rb', line 78
def flyweight_custom_control_classes
@flyweight_custom_control_classes ||= {}
end
|
.for(keyword) ⇒ Object
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
|
# File 'lib/glimmer/libui/custom_control.rb', line 44
def for(keyword)
unless flyweight_custom_control_classes.keys.include?(keyword)
begin
= keyword.
to_s.
split(/__/).map do |namespace|
namespace.camelcase(:upper)
end
custom_control_namespaces.each do |base|
.reduce(base) do |result, namespace|
if !result.constants.include?(namespace)
namespace = result.constants.detect {|c| c.to_s.upcase == namespace.to_s.upcase } || namespace
end
begin
flyweight_custom_control_classes[keyword] = constant = result.const_get(namespace)
return constant if constant.ancestors.include?(Glimmer::LibUI::CustomControl)
flyweight_custom_control_classes[keyword] = constant
rescue => e
flyweight_custom_control_classes[keyword] = result
end
end
end
raise "#{keyword} has no custom control class!"
rescue => e
Glimmer::Config.logger.debug {e.message}
Glimmer::Config.logger.debug {"#{e.message}\n#{e.backtrace.join("\n")}"}
flyweight_custom_control_classes[keyword] = nil
end
end
flyweight_custom_control_classes[keyword]
end
|
.keyword ⇒ Object
Returns keyword to use for this custom control
83
84
85
|
# File 'lib/glimmer/libui/custom_control.rb', line 83
def keyword
self.name.underscore.gsub('::', '__')
end
|
.namespaces_for_class(m) ⇒ Object
98
99
100
101
102
103
104
|
# File 'lib/glimmer/libui/custom_control.rb', line 98
def namespaces_for_class(m)
return [m] if m.name.nil?
namespace_constants = m.name.split(/::/).map(&:to_sym)
namespace_constants.reduce([Object]) do |output, namespace_constant|
output += [output.last.const_get(namespace_constant)]
end[1..-1].uniq.reverse
end
|
.option(new_option, default: nil) ⇒ Object
131
132
133
134
135
136
|
# File 'lib/glimmer/libui/custom_control.rb', line 131
def option(new_option, default: nil)
new_option = new_option.to_s.to_sym
new_options = {new_option => default}
@options = options.merge(new_options)
def_option_attr_accessors(new_options)
end
|
.options(*new_options) ⇒ Object
Allows defining convenience option accessors for an array of option names Example: ‘options :color1, :color2` defines `#color1` and `#color2` where they return the instance values `options` and `options` respectively. Can be called multiple times to set more options additively. When passed no arguments, it returns list of all option names captured so far
120
121
122
123
124
125
126
127
128
129
|
# File 'lib/glimmer/libui/custom_control.rb', line 120
def options(*new_options)
new_options = new_options.compact.map(&:to_s).map(&:to_sym)
if new_options.empty?
@options ||= {} else
new_options = new_options.reduce({}) {|new_options_hash, new_option| new_options_hash.merge(new_option => nil)}
@options = options.merge(new_options)
def_option_attr_accessors(new_options)
end
end
|
.reset_custom_control_namespaces ⇒ Object
110
111
112
|
# File 'lib/glimmer/libui/custom_control.rb', line 110
def reset_custom_control_namespaces
@custom_control_namespaces = Set[Object, Glimmer::LibUI]
end
|
.shortcut_keyword ⇒ Object
Returns shortcut keyword to use for this custom control (keyword minus namespace)
88
89
90
|
# File 'lib/glimmer/libui/custom_control.rb', line 88
def shortcut_keyword
self.name.underscore.gsub('::', '__').split('__').last
end
|
Instance Method Details
#can_handle_listener?(listener) ⇒ Boolean
197
198
199
|
# File 'lib/glimmer/libui/custom_control.rb', line 197
def can_handle_listener?(listener)
body_root&.can_handle_listener?(listener.to_s)
end
|
#handle_listener(listener, &block) ⇒ Object
201
202
203
|
# File 'lib/glimmer/libui/custom_control.rb', line 201
def handle_listener(listener, &block)
body_root.handle_listener(listener.to_s, &block)
end
|
#has_instance_method?(method_name) ⇒ Boolean
This method ensures it has an instance method not coming from Glimmer DSL
206
207
208
209
210
211
212
|
# File 'lib/glimmer/libui/custom_control.rb', line 206
def has_instance_method?(method_name)
respond_to?(method_name) and
!@body_root.respond_to_libui?(method_name) and
(method(method_name) rescue nil) and
!method(method_name)&.source_location&.first&.include?('glimmer/dsl/engine.rb') and
!method(method_name)&.source_location&.first&.include?('glimmer/libui/control_proxy.rb')
end
|
#initialize(keyword, parent, args, options, &content) ⇒ Object
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
|
# File 'lib/glimmer/libui/custom_control.rb', line 167
def initialize(keyword, parent, args, options, &content)
@parent_proxy = @parent = parent
options ||= {}
@options = self.class.options.merge(options)
@content = ProcTracker.new(content) if content
execute_hook('before_body')
body_block = self.class.instance_variable_get("@body_block")
raise Glimmer::Error, 'Invalid custom control for having no body! Please define body block!' if body_block.nil?
@body_root = instance_exec(&body_block)
raise Glimmer::Error, 'Invalid custom control for having an empty body! Please fill body block!' if @body_root.nil?
@libui = @body_root.libui
execute_hook('after_body')
post_add_content if content.nil?
end
|
#observer_registrations ⇒ Object
193
194
195
|
# File 'lib/glimmer/libui/custom_control.rb', line 193
def observer_registrations
@observer_registrations ||= []
end
|
#post_add_content ⇒ Object
189
190
191
|
# File 'lib/glimmer/libui/custom_control.rb', line 189
def post_add_content
end
|
#post_initialize_child(child) ⇒ Object
Subclasses may override to perform post initialization work on an added child
185
186
187
|
# File 'lib/glimmer/libui/custom_control.rb', line 185
def post_initialize_child(child)
end
|
#respond_to?(method_name, *args, &block) ⇒ Boolean
234
235
236
237
238
239
|
# File 'lib/glimmer/libui/custom_control.rb', line 234
def respond_to?(method_name, *args, &block)
result = false
result ||= super
result ||= can_handle_listener?(method_name)
result ||= @body_root.respond_to?(method_name, *args, &block)
end
|