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

#pretty_print, #to_json

Constructor Details

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

Returns a new instance of Kw.



5129
5130
5131
5132
5133
 
# File 'lib/syntax_tree/node.rb', line 5129

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



5127
5128
5129
 
# File 'lib/syntax_tree/node.rb', line 5127

def comments
  @comments
end

#value ⇒ Object (readonly)

String

the value of the keyword



5124
5125
5126
 
# File 'lib/syntax_tree/node.rb', line 5124

def value
  @value
end

Instance Method Details

#accept(visitor) ⇒ Object 



5135
5136
5137
 
# File 'lib/syntax_tree/node.rb', line 5135

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

#child_nodes ⇒ Object Also known as: deconstruct 



5139
5140
5141
 
# File 'lib/syntax_tree/node.rb', line 5139

def child_nodes
  []
end

#deconstruct_keys(keys) ⇒ Object 



5145
5146
5147
 
# File 'lib/syntax_tree/node.rb', line 5145

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

#format(q) ⇒ Object 



5149
5150
5151
 
# File 'lib/syntax_tree/node.rb', line 5149

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