Class: Vedeu::Cursors::Cursor

Inherits:
Object
  • Object
show all
Extended by:
Forwardable
Includes:
Repositories::Model, Toggleable
Defined in:
lib/vedeu/cursors/cursor.rb,
lib/vedeu/cursors/repository.rb

Overview

Repository

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Vedeu::Cursors::Cursor

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of Vedeu::Cursors::Cursor.

Parameters:

Options Hash (attributes):

  • name (String|Symbol) —

    The name of the interface this cursor belongs to.

  • ox (Fixnum) —

    The offset x coordinate.

  • oy (Fixnum) —

    The offset y coordinate.

  • repository (Object) —
    Vedeu::Repositories::Repository
  • visible (Boolean) —

    The visibility of the cursor.

  • x (Fixnum) —

    The terminal x coordinate for the cursor.

  • y (Fixnum) —

    The terminal y coordinate for the cursor.



61
62
63
64
65
 
# File 'lib/vedeu/cursors/cursor.rb', line 61

def initialize(attributes = {})
  defaults.merge!(attributes).each do |key, value|
    instance_variable_set("@#{key}", value)
  end
end

Instance Attribute Details

#name ⇒ String|Symbol (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns:

  • (String|Symbol) 


26
27
28
 
# File 'lib/vedeu/cursors/cursor.rb', line 26

def name
  @name
end

#ox ⇒ Fixnum

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns:

  • (Fixnum) 


209
210
211
 
# File 'lib/vedeu/cursors/cursor.rb', line 209

def ox
  @ox = @ox < 0 ? 0 : @ox
end

#oy ⇒ Fixnum

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns:

  • (Fixnum) 


214
215
216
 
# File 'lib/vedeu/cursors/cursor.rb', line 214

def oy
  @oy = @oy < 0 ? 0 : @oy
end

#repository ⇒ Vedeu::Repositories::Repository Originally defined in module Repositories::Model

Returns:

#visible ⇒ Boolean Also known as: visible? Originally defined in module Toggleable

Returns Whether the toggleable is visible.

Returns:

  • (Boolean) —

    Whether the toggleable is visible.

#x ⇒ Fixnum

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns The column/character coordinate.

Returns:

  • (Fixnum) —

    The column/character coordinate.



246
247
248
 
# File 'lib/vedeu/cursors/cursor.rb', line 246

def x
  @x = Vedeu::Point.coerce(value: @x, min: bx, max: bxn).value
end

#y ⇒ Fixnum

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns The row/line coordinate.

Returns:

  • (Fixnum) —

    The row/line coordinate.



251
252
253
 
# File 'lib/vedeu/cursors/cursor.rb', line 251

def y
  @y = Vedeu::Point.coerce(value: @y, min: by, max: byn).value
end

Instance Method Details

#absent?(variable) ⇒ Boolean Originally defined in module Vedeu::Common

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a boolean indicating whether a variable is nil or empty.

Parameters:

  • variable (String|Symbol|Array|Fixnum) —

    The variable to check.

Returns:

#attributes ⇒ Hash<Symbol => Boolean|Fixnum|String| Vedeu::Cursors::Repository>

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns:



69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/vedeu/cursors/cursor.rb', line 69

def attributes
  {
    name:       @name,
    ox:         ox,
    oy:         oy,
    repository: @repository,
    visible:    @visible,
    x:          x,
    y:          y,
  }
end

#become(klass, attributes) ⇒ Class Originally defined in module Vedeu::Common

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Converts one class into another.

Parameters:

  • klass (Class) —

    The class to become an instance of.

  • attributes (Hash) —

    The attributes of klass.

Returns:

  • (Class) —

    Returns a new instance of klass.

#boolean(value) ⇒ Boolean Originally defined in module Vedeu::Common

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a boolean indicating the value was a boolean.

Parameters:

  • value (void)

Returns:

#boolean?(value) ⇒ Boolean Originally defined in module Vedeu::Common

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a boolean indicating whether the value is a Boolean.

Parameters:

Returns:

#coordinate(offset, type) ⇒ Vedeu::Cursors::Coordinate (private)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Determine correct x and y related coordinates.

Returns:



267
268
269
270
271
 
# File 'lib/vedeu/cursors/cursor.rb', line 267

def coordinate(offset, type)
  Vedeu::Cursors::Coordinate.new(name:   name,
                                 offset: offset,
                                 type:   type)
end

#defaults ⇒ Hash<Symbol => Boolean|Fixnum|String| Vedeu::Cursors::Repository> (private)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

The default values for a new instance of this class.

Returns:



277
278
279
280
281
282
283
284
285
286
287
 
# File 'lib/vedeu/cursors/cursor.rb', line 277

def defaults
  {
    name:       '',
    ox:         0,
    oy:         0,
    repository: Vedeu.cursors,
    visible:    false,
    x:          1,
    y:          1,
  }
end

#eql?(other) ⇒ Boolean Also known as: ==

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

An object is equal when its values are the same.

Parameters:

Returns:



85
86
87
 
# File 'lib/vedeu/cursors/cursor.rb', line 85

def eql?(other)
  self.class == other.class && name == other.name
end

#escape?(value) ⇒ Boolean Originally defined in module Vedeu::Common

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a boolean indicating whether the value is an escape sequence object (e.g. Vedeu::Cells::Escape.)

Returns:

#escape_sequence ⇒ Vedeu::Cells::Cursor (private)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns:



290
291
292
 
# File 'lib/vedeu/cursors/cursor.rb', line 290

def escape_sequence
  Vedeu::Cells::Cursor.new(position: position, value: visibility)
end

#falsy?(value) ⇒ Boolean Originally defined in module Vedeu::Common

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a boolean indicating whether the value should be considered false.

Parameters:

  • value (void)

Returns:

#geometry ⇒ Object (private)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns the geometry for the interface.



260
261
262
 
# File 'lib/vedeu/cursors/cursor.rb', line 260

def geometry
  @geometry ||= Vedeu.geometries.by_name(name)
end

#hash?(value) ⇒ Boolean Originally defined in module Vedeu::Common

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a boolean indicating whether the value is a Hash.

Parameters:

  • value (Hash|void)

Returns:

#hide ⇒ Vedeu::Cells::Cursor

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Hide a named cursor, or without a name, the cursor of the currently focussed interface.

Examples:

Vedeu.trigger(:_hide_cursor_, name)
Vedeu.trigger(:_hide_cursor_, Vedeu.focus)
Vedeu.trigger(:_hide_cursor_)
Vedeu.hide_cursor(name)
Vedeu.hide_cursor(Vedeu.focus)
Vedeu.hide_cursor

Returns:



200
201
202
203
204
205
206
 
# File 'lib/vedeu/cursors/cursor.rb', line 200

def hide
  super

  Vedeu.log(type: :cursor, message: "Hiding cursor: '#{name}'")

  render
end

#inspect ⇒ String

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns:

  • (String) 


91
92
93
94
 
# File 'lib/vedeu/cursors/cursor.rb', line 91

def inspect
  "<#{self.class.name} name:'#{name}', x:#{x}, y:#{y}, ox:#{ox}, " \
  "oy:#{oy}, visible:#{visible}>"
end

#line_model? ⇒ Boolean Originally defined in module Vedeu::Common

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a boolean indicating the model is a Views::Line.

Returns:

#move_down ⇒ Vedeu::Cursors::Cursor

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Moves the cursor down by one row.

Vedeu.trigger(:_cursor_down_, name)
Vedeu.trigger(:_cursor_down_, Vedeu.focus)

Returns:



102
103
104
105
106
107
 
# File 'lib/vedeu/cursors/cursor.rb', line 102

def move_down
  @oy += 1
  @y = coordinate(oy, :y).y

  self
end

#move_left ⇒ Vedeu::Cursors::Cursor

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Moves the cursor left by one column.

Vedeu.trigger(:_cursor_left_, name)
Vedeu.trigger(:_cursor_left_, Vedeu.focus)

Returns:



115
116
117
118
119
120
 
# File 'lib/vedeu/cursors/cursor.rb', line 115

def move_left
  @ox -= 1
  @x = coordinate(ox, :x).x

  self
end

#move_origin ⇒ Vedeu::Cursors::Cursor

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Moves the cursor to the top left of the named interface.

Vedeu.trigger(:_cursor_origin_, name)
Vedeu.trigger(:_cursor_origin_, Vedeu.focus)

Returns:



128
129
130
131
132
133
134
135
 
# File 'lib/vedeu/cursors/cursor.rb', line 128

def move_origin
  @x = bx
  @y = by
  @ox = 0
  @oy = 0

  store
end

#move_right ⇒ Vedeu::Cursors::Cursor

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Moves the cursor right by one column.

Vedeu.trigger(:_cursor_right_, name)
Vedeu.trigger(:_cursor_right_, Vedeu.focus)

Returns:



143
144
145
146
147
148
 
# File 'lib/vedeu/cursors/cursor.rb', line 143

def move_right
  @ox += 1
  @x = coordinate(ox, :x).x

  self
end

#move_up ⇒ Vedeu::Cursors::Cursor

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Moves the cursor up by one row.

Vedeu.trigger(:_cursor_up_, name)
Vedeu.trigger(:_cursor_up_, Vedeu.focus)

Returns:



156
157
158
159
160
161
 
# File 'lib/vedeu/cursors/cursor.rb', line 156

def move_up
  @oy -= 1
  @y = coordinate(oy, :y).y

  self
end

#new_attributes(new_y = y, new_x = x, new_oy = oy, new_ox = ox) ⇒ Hash<Symbol => Fixnum> (private)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns:

  • (Hash<Symbol => Fixnum>) 


295
296
297
 
# File 'lib/vedeu/cursors/cursor.rb', line 295

def new_attributes(new_y = y, new_x = x, new_oy = oy, new_ox = ox)
  attributes.merge!(x: new_x, y: new_y, ox: new_ox, oy: new_oy)
end

#numeric?(value) ⇒ Boolean Originally defined in module Vedeu::Common

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a boolean indicating whether the value is a Fixnum.

Parameters:

  • value (Fixnum|void)

Returns:

#position ⇒ Vedeu::Geometries::Position

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Return the position of this cursor.

Returns:



221
222
223
 
# File 'lib/vedeu/cursors/cursor.rb', line 221

def position
  @position = Vedeu::Geometries::Position.coerce([y, x])
end

#present?(variable) ⇒ Boolean Originally defined in module Vedeu::Common

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a boolean indicating whether a variable has a useful value.

Parameters:

  • variable (String|Symbol|Array|Fixnum) —

    The variable to check.

Returns:

#render ⇒ Array<Vedeu::Cells::Cursor>

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Renders the cursor.

Returns:



166
167
168
 
# File 'lib/vedeu/cursors/cursor.rb', line 166

def render
  Vedeu.render_output(escape_sequence)
end

#show ⇒ Vedeu::Cells::Cursor

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Show a named cursor, or without a name, the cursor of the currently focussed interface.

Examples:

Vedeu.trigger(:_show_cursor_, name)
Vedeu.trigger(:_show_cursor_, Vedeu.focus)
Vedeu.trigger(:_show_cursor_)
Vedeu.show_cursor(name)
Vedeu.show_cursor(Vedeu.focus)
Vedeu.show_cursor

Returns:



237
238
239
240
241
242
243
 
# File 'lib/vedeu/cursors/cursor.rb', line 237

def show
  super

  Vedeu.log(type: :cursor, message: "Showing cursor: '#{name}'")

  render
end

#snake_case(klass) ⇒ String Originally defined in module Vedeu::Common

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Converts a class name to a lowercase snake case string.

Examples:

snake_case(MyClassName) # => "my_class_name"
snake_case(NameSpaced::ClassName)
# => "name_spaced/class_name"

snake_case('MyClassName') # => "my_class_name"
snake_case(NameSpaced::ClassName)
# => "name_spaced/class_name"

Parameters:

  • klass (Module|Class|String)

Returns:

  • (String)

#store(&block) ⇒ void Originally defined in module Repositories::Model

TODO:

Perhaps some validation could be added here?

Note:

If a block is given, store the model, return the model after yielding.

This method returns an undefined value.

Returns The model instance stored in the repository.

#stream_model? ⇒ Boolean Originally defined in module Vedeu::Common

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a boolean indicating the model is a Views::Stream.

Returns:

#string?(value) ⇒ Boolean Originally defined in module Vedeu::Common

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a boolean indicating whether the value is a Fixnum.

Parameters:

  • value (String|void)

Returns:

#to_a ⇒ Array<Fixnum>

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns:

  • (Array<Fixnum>) 


171
172
173
 
# File 'lib/vedeu/cursors/cursor.rb', line 171

def to_a
  position.to_a
end

#to_s(&block) ⇒ String Also known as: to_str

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns an escape sequence to position the cursor and set its visibility. When passed a block, will position the cursor, yield and return the original position.

Parameters:

  • block (Proc)

Returns:

  • (String) 


181
182
183
184
185
 
# File 'lib/vedeu/cursors/cursor.rb', line 181

def to_s(&block)
  return escape_sequence.to_s unless block_given?

  "#{position}#{yield}#{escape_sequence}"
end

#toggle ⇒ Boolean Originally defined in module Toggleable

Toggle the visible state and store the model. When the model is hidden, then it is shown, and vice versa.

Returns:

#truthy?(value) ⇒ Boolean Originally defined in module Vedeu::Common

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a boolean indicating whether the value should be considered true.

Parameters:

  • value (void)

Returns:

#view_model? ⇒ Boolean Originally defined in module Vedeu::Common

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a boolean indicating the model is a Views::View.

Returns:

#visibility ⇒ String (private)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns the escape sequence for setting the visibility of the cursor.

Returns:

  • (String) 


303
304
305
306
307
 
# File 'lib/vedeu/cursors/cursor.rb', line 303

def visibility
  return Vedeu.esc.show_cursor if visible?

  Vedeu.esc.hide_cursor
end