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 



6004
6005
6006
6007
6008
6009
 
# File 'lib/syntax_tree/node.rb', line 6004

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

Instance Attribute Details

#comments ⇒ Object (readonly)

Array[ Comment | EmbDoc ]

the comments attached to this node



6002
6003
6004
 
# File 'lib/syntax_tree/node.rb', line 6002

def comments
  @comments
end

#name ⇒ Object (readonly)

Symbol

the symbol version of the value



5999
6000
6001
 
# File 'lib/syntax_tree/node.rb', line 5999

def name
  @name
end

#value ⇒ Object (readonly)

String

the value of the keyword



5996
5997
5998
 
# File 'lib/syntax_tree/node.rb', line 5996

def value
  @value
end

Instance Method Details

#accept(visitor) ⇒ Object 



6011
6012
6013
 
# File 'lib/syntax_tree/node.rb', line 6011

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

#child_nodes ⇒ Object Also known as: deconstruct 



6015
6016
6017
 
# File 'lib/syntax_tree/node.rb', line 6015

def child_nodes
  []
end

#deconstruct_keys(_keys) ⇒ Object 



6021
6022
6023
 
# File 'lib/syntax_tree/node.rb', line 6021

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

#format(q) ⇒ Object 



6025
6026
6027
 
# File 'lib/syntax_tree/node.rb', line 6025

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