Class: SyntaxTree::Kw

Inherits:
Node
  • Object
show all
Defined in:
lib/syntax_tree/node.rb

Overview

Kw represents the use of a keyword. It can be almost anywhere in the syntax tree, so you end up seeing it quite a lot.

if value
end

In the above example, there would be two Kw nodes: one for the if and one for the end. Note that anything that matches the list of keywords in Ruby will use a Kw, so if you use a keyword in a symbol literal for instance:

:if

then the contents of the symbol node will contain a Kw node.

Instance Attribute Summary collapse

Attributes inherited from Node

#location

Instance Method Summary collapse

Methods inherited from Node

#construct_keys, #pretty_print, #to_json

Constructor Details

#initialize(value:, location:, comments: []) ⇒ Kw

Returns a new instance of Kw.



5836
5837
5838
5839
5840
 
# File 'lib/syntax_tree/node.rb', line 5836

def initialize(value:, location:, comments: [])
  @value = value
  @location = location
  @comments = comments
end

Instance Attribute Details

#comments ⇒ Object (readonly)

Array[ Comment | EmbDoc ]

the comments attached to this node



5834
5835
5836
 
# File 'lib/syntax_tree/node.rb', line 5834

def comments
  @comments
end

#value ⇒ Object (readonly)

String

the value of the keyword



5831
5832
5833
 
# File 'lib/syntax_tree/node.rb', line 5831

def value
  @value
end

Instance Method Details

#accept(visitor) ⇒ Object 



5842
5843
5844
 
# File 'lib/syntax_tree/node.rb', line 5842

def accept(visitor)
  visitor.visit_kw(self)
end

#child_nodes ⇒ Object Also known as: deconstruct 



5846
5847
5848
 
# File 'lib/syntax_tree/node.rb', line 5846

def child_nodes
  []
end

#deconstruct_keys(_keys) ⇒ Object 



5852
5853
5854
 
# File 'lib/syntax_tree/node.rb', line 5852

def deconstruct_keys(_keys)
  { value: value, location: location, comments: comments }
end

#format(q) ⇒ Object 



5856
5857
5858
 
# File 'lib/syntax_tree/node.rb', line 5856

def format(q)
  q.text(value)
end