Class: SublimeDSL::SublimeText::Mouse

Inherits:
Object
  • Object
show all
Defined in:
lib/sublime_dsl/sublime_text/mouse.rb

Defined Under Namespace

Classes: Button, Click

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name) ⇒ Mouse



24
25
26
27
28
29
# File 'lib/sublime_dsl/sublime_text/mouse.rb', line 24

def initialize(name)
  @name = name
  @buttons = []
  @modifiers = []
  @clicks = []
end

Instance Attribute Details

#buttonsObject (readonly)

Returns the value of attribute buttons.



22
23
24
# File 'lib/sublime_dsl/sublime_text/mouse.rb', line 22

def buttons
  @buttons
end

#modifiersObject (readonly)

Returns the value of attribute modifiers.



22
23
24
# File 'lib/sublime_dsl/sublime_text/mouse.rb', line 22

def modifiers
  @modifiers
end

#nameObject (readonly) Also known as: to_s

Returns the value of attribute name.



22
23
24
# File 'lib/sublime_dsl/sublime_text/mouse.rb', line 22

def name
  @name
end

Class Method Details

.create_sublime_mouseObject



12
13
14
15
16
17
18
19
20
# File 'lib/sublime_dsl/sublime_text/mouse.rb', line 12

def self.create_sublime_mouse
  mouse = new('Sublime Text')
  (1..9).each { |i| mouse.add_button "button#{i}" }
  mouse.add_button "scroll_up"
  mouse.add_button "scroll_down"
  %w(shift ctrl alt super).each { |m| mouse.add_modifier m }
  mouse.modifiers.concat mouse.buttons
  mouse
end

.sublimeObject



8
9
10
# File 'lib/sublime_dsl/sublime_text/mouse.rb', line 8

def self.sublime
  @sublime ||= create_sublime_mouse
end

Instance Method Details

#add_button(st_name, name = nil) ⇒ Object



49
50
51
# File 'lib/sublime_dsl/sublime_text/mouse.rb', line 49

def add_button(st_name, name = nil)
  @buttons << Button.new(st_name, name)
end

#add_modifier(st_name, name = nil) ⇒ Object



53
54
55
# File 'lib/sublime_dsl/sublime_text/mouse.rb', line 53

def add_modifier(st_name, name = nil)
  @modifiers << Button.new(st_name, name)
end

#button(name) ⇒ Object



41
42
43
# File 'lib/sublime_dsl/sublime_text/mouse.rb', line 41

def button(name)
  buttons.find { |b| b.name == name }
end

#clicks_hashObject



57
58
59
# File 'lib/sublime_dsl/sublime_text/mouse.rb', line 57

def clicks_hash
  @clicks_hash ||= {}
end

#clone(name) ⇒ Object



33
34
35
36
37
38
39
# File 'lib/sublime_dsl/sublime_text/mouse.rb', line 33

def clone(name)
  clone = Mouse.new(name)
  buttons.each { |b| clone.add_button b.st_name, b.name }
  (modifiers - buttons).each { |m| clone.add_modifier m.st_name, m.name }
  clone.modifiers.concat clone.buttons
  clone
end

#ensure_click(spec) ⇒ Object



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
# File 'lib/sublime_dsl/sublime_text/mouse.rb', line 69

def ensure_click(spec)
  *modifier_names, button_name = spec.split('+')

  button = button(button_name) or
    raise Error, "invalid button #{button_name.inspect}"

  # check & reorder the modifiers
  unless modifier_names.empty?
    sorted = []
    modifier_names.each do |name|
      i = modifiers_index_hash[name]
      i or raise Error, "invalid modifier #{name.inspect}"
      sorted[i] = name
    end
    modifier_names = sorted.compact
  end

  # if there is a registered click for this spec, return it
  std_spec = [*modifier_names, button_name].join('+')
  click = clicks_hash[std_spec]
  return click if click

  # can't have the button in the modifiers
  modifier_names.include?(button_name) and
    raise Error, "can't have the button in the modifiers: #{spec.inspect}"

  # create and register the click
  modifiers = modifier_names.map { |n| modifier(n) }
  click = Click.new(modifiers, button)
  clicks_hash[click.to_spec] = click

  click
end

#modifier(name) ⇒ Object



45
46
47
# File 'lib/sublime_dsl/sublime_text/mouse.rb', line 45

def modifier(name)
  modifiers.find { |b| b.name == name }
end

#modifiers_index_hashObject



61
62
63
64
65
66
67
# File 'lib/sublime_dsl/sublime_text/mouse.rb', line 61

def modifiers_index_hash
  @modifiers_index_hash ||= begin
    h = {}
    modifiers.each_with_index { |b,i| h[b.name] = i }
    h
  end
end