Class: Glimmer::SWT::Custom::CodeText

Inherits:
Object
  • Object
show all
Includes:
UI::CustomWidget
Defined in:
lib/glimmer/swt/custom/code_text.rb

Overview

CodeText is a customization of StyledText with support for Ruby Syntax Highlighting

Constant Summary collapse

REGEX_COLOR_HEX6 = 
/^#([0-9a-f]{2})([0-9a-f]{2})([0-9a-f]{2})$/

Instance Attribute Summary collapse

Attributes included from UI::CustomWidget

#body_root, #options, #parent, #parent_proxy, #swt_style, #swt_widget

Class Method Summary collapse

Instance Method Summary collapse

Methods included from UI::CustomWidget

add_custom_widget_namespaces_for, #add_observer, after_body, #async_exec, #attribute_setter, before_body, body, #can_add_observer?, #can_handle_observation_request?, #content, current_custom_widgets, custom_widget_namespaces, def_option_attr_accessors, #disposed?, flyweight_custom_widget_classes, for, #get_attribute, #handle_observation_request, #has_attribute?, #has_style?, #initialize, keyword, #local_respond_to?, namespaces_for_class, #observer_registrations, option, options, #pack, #post_initialize_child, reset_custom_widget_namespaces, #set_attribute, shortcut_keyword, #sync_exec, #timer_exec

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(method_name, *args, &block) ⇒ Object 



40
41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/glimmer/swt/custom/code_text.rb', line 40

def method_missing(method_name, *args, &block)
  dsl_mode = @dsl_mode || args.last.is_a?(Hash) && args.last[:dsl]
  if dsl_mode
    args.pop if args.last.is_a?(Hash) && args.last[:dsl]
    super(method_name, *args, &block)
  elsif @styled_text_proxy&.respond_to?(method_name, *args, &block)
    @line_numbers_styled_text_proxy&.send(method_name, *args, &block) if method_name.to_s == 'font='
    @styled_text_proxy&.send(method_name, *args, &block)
  else
    super
  end
end

Instance Attribute Details

#line_numbers_styled_text_proxy ⇒ Object (readonly)

Returns the value of attribute line_numbers_styled_text_proxy.



38
39
40
 
# File 'lib/glimmer/swt/custom/code_text.rb', line 38

def line_numbers_styled_text_proxy
  @line_numbers_styled_text_proxy
end

#lines_width ⇒ Object (readonly)

Returns the value of attribute lines_width.



38
39
40
 
# File 'lib/glimmer/swt/custom/code_text.rb', line 38

def lines_width
  @lines_width
end

#styled_text_proxy ⇒ Object (readonly)

Returns the value of attribute styled_text_proxy.



38
39
40
 
# File 'lib/glimmer/swt/custom/code_text.rb', line 38

def styled_text_proxy
  @styled_text_proxy
end

#styled_text_proxy_text ⇒ Object

Returns the value of attribute styled_text_proxy_text.



37
38
39
 
# File 'lib/glimmer/swt/custom/code_text.rb', line 37

def styled_text_proxy_text
  @styled_text_proxy_text
end

#styled_text_proxy_top_pixel ⇒ Object

Returns the value of attribute styled_text_proxy_top_pixel.



37
38
39
 
# File 'lib/glimmer/swt/custom/code_text.rb', line 37

def styled_text_proxy_top_pixel
  @styled_text_proxy_top_pixel
end

Class Method Details

.languages ⇒ Object 



11
12
13
14
 
# File 'lib/glimmer/swt/custom/code_text.rb', line 11

def languages
  require 'rouge'
  Rouge::Lexer.all.map {|lexer| lexer.tag}.sort
end

.lexers ⇒ Object 



16
17
18
19
 
# File 'lib/glimmer/swt/custom/code_text.rb', line 16

def lexers
  require 'rouge'
  Rouge::Lexer.all.sort_by(&:title)
end

Instance Method Details

#code_text_widget ⇒ Object 



144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'lib/glimmer/swt/custom/code_text.rb', line 144

def code_text_widget
  @styled_text_proxy = styled_text(swt_style) {
#             custom_widget_property_owner # TODO implement to route properties here without declaring method_missing
    layout_data :fill, :fill, true, true if lines
    text bind(self, :styled_text_proxy_text) if lines
    top_pixel bind(self, :styled_text_proxy_top_pixel) if lines
    font name: @font_name, height: OS.mac? ? 15 : 12
    foreground rgb(75, 75, 75)
    left_margin 5
    top_margin 5
    right_margin 5
    bottom_margin 5
    
    if default_behavior
      on_key_pressed { |event|
        character = event.keyCode.chr rescue nil
        case [event.stateMask, character]
        when [(OS.mac? ? swt(:command) : swt(:ctrl)), 'a']
          @styled_text_proxy.swt_widget.selectAll
        when [(swt(:ctrl) if OS.mac?), 'a']
          jump_to_beginning_of_line
        when [(swt(:ctrl) if OS.mac?), 'e']
          jump_to_end_of_line
        end
      }
    end
    
    on_modify_text { |event|
      # clear unnecessary syntax highlighting cache on text updates, and do it async to avoid affecting performance
      new_text = event.data
      async_exec {
        unless @syntax_highlighting.nil?
          lines = new_text.to_s.split("\n")
          line_diff = @syntax_highlighting.keys - lines
          line_diff.each do |line|
            @syntax_highlighting.delete(line)
          end
        end
      }
    }
          
    on_line_get_style { |line_style_event|
      begin
        styles = []
        style_data = nil
        syntax_highlighting(line_style_event.lineText).to_a.each do |token_hash|
          start_index = token_hash[:token_index]
          size = token_hash[:token_text].size
          style_data = Rouge::Theme.find(theme).new.style_for(token_hash[:token_type])
          foreground_color = hex_color_to_swt_color(style_data[:fg], [:black])
          background_color = hex_color_to_swt_color(style_data[:bg], [:white])
          font_styles = []
          font_styles << :bold if style_data[:bold]
          font_styles << :italic if style_data[:italic]
          font_style = SWTProxy[*font_styles]
          styles << StyleRange.new(line_style_event.lineOffset + start_index, size, foreground_color, background_color, font_style)
        end
        line_style_event.styles = styles.to_java(StyleRange) unless styles.empty?
      rescue => e
        Glimmer::Config.logger.error {"Error encountered with style data: #{style_data}"}
        Glimmer::Config.logger.error {e.message}
        Glimmer::Config.logger.error {e.full_message}
      end
    }
  }
end

#has_instance_method?(method_name) ⇒ Boolean

Returns:

  • (Boolean) 


63
64
65
 
# File 'lib/glimmer/swt/custom/code_text.rb', line 63

def has_instance_method?(method_name)
  respond_to?(method_name)
end

#hex_color_to_swt_color(color_data, default_color) ⇒ Object

TODO extract this to ColorProxy



235
236
237
238
239
240
241
 
# File 'lib/glimmer/swt/custom/code_text.rb', line 235

def hex_color_to_swt_color(color_data, default_color)
  color_data = "##{color_data.chars.drop(1).map {|c| c*2}.join}" if color_data.is_a?(String) && color_data.start_with?('#') && color_data&.size == 4
  color_data = color_data.match(REGEX_COLOR_HEX6).to_a.drop(1).map {|c| "0x#{c}".hex}.to_a if color_data.is_a?(String) && color_data.start_with?('#')
  color_data = [color_data] unless color_data.nil? || color_data.empty? || color_data.is_a?(Array)
  color_data = default_color if color_data.nil? || color_data.empty?
  color(*color_data).swt_color
end

#jump_to_beginning_of_line ⇒ Object 



243
244
245
246
247
 
# File 'lib/glimmer/swt/custom/code_text.rb', line 243

def jump_to_beginning_of_line
  current_line_index = @styled_text_proxy.swt_widget.getLineAtOffset(@styled_text_proxy.swt_widget.getCaretOffset)
  beginning_of_current_line_offset = @styled_text_proxy.swt_widget.getOffsetAtLine(current_line_index)
  @styled_text_proxy.swt_widget.setSelection(beginning_of_current_line_offset, beginning_of_current_line_offset)
end

#jump_to_end_of_line ⇒ Object 



249
250
251
252
253
254
255
 
# File 'lib/glimmer/swt/custom/code_text.rb', line 249

def jump_to_end_of_line
  current_line_index = @styled_text_proxy.swt_widget.getLineAtOffset(@styled_text_proxy.swt_widget.getCaretOffset)
  current_line = @styled_text_proxy.swt_widget.getLine(current_line_index)
  beginning_of_current_line_offset = @styled_text_proxy.swt_widget.getOffsetAtLine(current_line_index)
  new_offset = beginning_of_current_line_offset + current_line.size
  @styled_text_proxy.swt_widget.setSelection(new_offset, new_offset)
end

#lexer ⇒ Object 



227
228
229
230
231
232
 
# File 'lib/glimmer/swt/custom/code_text.rb', line 227

def lexer
  require 'rouge'
  # TODO Try to use Rouge::Lexer.find_fancy('guess', code) in the future to guess the language or otherwise detect it from file extension
  @lexer ||= Rouge::Lexer.find_fancy(language)
  @lexer ||= Rouge::Lexer.find_fancy('ruby') # default to Ruby if no lexer is found
end

#line_numbers_block=(block) ⇒ Object 



71
72
73
 
# File 'lib/glimmer/swt/custom/code_text.rb', line 71

def line_numbers_block=(block)
  @line_numbers_styled_text_proxy.content(&block)
end

#respond_to?(method_name, *args, &block) ⇒ Boolean

Returns:

  • (Boolean) 


53
54
55
56
57
58
59
60
61
 
# File 'lib/glimmer/swt/custom/code_text.rb', line 53

def respond_to?(method_name, *args, &block)
  dsl_mode = @dsl_mode || args.last.is_a?(Hash) && args.last[:dsl]
  if dsl_mode
    args = args[0...-1] if args.last.is_a?(Hash) && args.last[:dsl]
    super(method_name, *args, &block)
  else
    super || @styled_text_proxy&.respond_to?(method_name, *args, &block)
  end
end

#root_block=(block) ⇒ Object 



67
68
69
 
# File 'lib/glimmer/swt/custom/code_text.rb', line 67

def root_block=(block)
  body_root.content(&block)
end

#syntax_highlighting(text) ⇒ Object 



211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
 
# File 'lib/glimmer/swt/custom/code_text.rb', line 211

def syntax_highlighting(text)
  return [] if text.to_s.strip.empty?
  @syntax_highlighting ||= {}
  unless @syntax_highlighting.keys.include?(text)
    lex = lexer.lex(text).to_a
    text_size = 0
    @syntax_highlighting[text] = lex.map do |pair|
      {token_type: pair.first, token_text: pair.last}
    end.each do |hash|
      hash[:token_index] = text_size
      text_size += hash[:token_text].size
    end
  end
  @syntax_highlighting[text]
end