Class: LanguageServer::Protocol::Interface::FoldingRange

Inherits:
Object
  • Object
show all
Defined in:
lib/language_server/protocol/interface/folding_range.rb

Overview

Represents a folding range. To be valid, start and end line must be bigger than zero and smaller than the number of lines in the document. Clients are free to ignore invalid ranges.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(start_line:, start_character: nil, end_line:, end_character: nil, kind: nil) ⇒ FoldingRange

Returns a new instance of FoldingRange.



10
11
12
13
14
15
16
17
18
19
20
 
# File 'lib/language_server/protocol/interface/folding_range.rb', line 10

def initialize(start_line:, start_character: nil, end_line:, end_character: nil, kind: nil)
  @attributes = {}

  @attributes[:startLine] = start_line
  @attributes[:startCharacter] = start_character if start_character
  @attributes[:endLine] = end_line
  @attributes[:endCharacter] = end_character if end_character
  @attributes[:kind] = kind if kind

  @attributes.freeze
end

Instance Attribute Details

#attributes ⇒ Object (readonly)

Returns the value of attribute attributes.



71
72
73
 
# File 'lib/language_server/protocol/interface/folding_range.rb', line 71

def attributes
  @attributes
end

Instance Method Details

#end_character ⇒ number

The zero-based character offset before the folded range ends. If not defined, defaults to the length of the end line.

Returns:

  • (number) 


56
57
58
 
# File 'lib/language_server/protocol/interface/folding_range.rb', line 56

def end_character
  attributes.fetch(:endCharacter)
end

#end_line ⇒ number

The zero-based end line of the range to fold. The folded area ends with the line’s last character. To be valid, the end must be zero or larger and smaller than the number of lines in the document.

Returns:

  • (number) 


47
48
49
 
# File 'lib/language_server/protocol/interface/folding_range.rb', line 47

def end_line
  attributes.fetch(:endLine)
end

#kind ⇒ string

Describes the kind of the folding range such as ‘comment` or `region`. The kind is used to categorize folding ranges and used by commands like ’Fold all comments’. See [FoldingRangeKind](#FoldingRangeKind) for an enumeration of standardized kinds.

Returns:

  • (string) 


67
68
69
 
# File 'lib/language_server/protocol/interface/folding_range.rb', line 67

def kind
  attributes.fetch(:kind)
end

#start_character ⇒ number

The zero-based character offset from where the folded range starts. If not defined, defaults to the length of the start line.

Returns:

  • (number) 


37
38
39
 
# File 'lib/language_server/protocol/interface/folding_range.rb', line 37

def start_character
  attributes.fetch(:startCharacter)
end

#start_line ⇒ number

The zero-based start line of the range to fold. The folded area starts after the line’s last character. To be valid, the end must be zero or larger and smaller than the number of lines in the document.

Returns:

  • (number) 


28
29
30
 
# File 'lib/language_server/protocol/interface/folding_range.rb', line 28

def start_line
  attributes.fetch(:startLine)
end

#to_hash ⇒ Object 



73
74
75
 
# File 'lib/language_server/protocol/interface/folding_range.rb', line 73

def to_hash
  attributes
end

#to_json(*args) ⇒ Object 



77
78
79
 
# File 'lib/language_server/protocol/interface/folding_range.rb', line 77

def to_json(*args)
  to_hash.to_json(*args)
end