Class: SyntaxTree::Kw
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
-
#comments ⇒ Object
readonly
- Array[ Comment | EmbDoc ]
-
the comments attached to this node.
-
#value ⇒ Object
readonly
- String
-
the value of the keyword.
Attributes inherited from Node
Instance Method Summary collapse
- #accept(visitor) ⇒ Object
- #child_nodes ⇒ Object (also: #deconstruct)
- #deconstruct_keys(_keys) ⇒ Object
- #format(q) ⇒ Object
-
#initialize(value:, location:, comments: []) ⇒ Kw
constructor
A new instance of Kw.
Methods inherited from Node
#construct_keys, #pretty_print, #to_json
Constructor Details
#initialize(value:, location:, comments: []) ⇒ Kw
Returns a new instance of Kw.
5736 5737 5738 5739 5740 |
# File 'lib/syntax_tree/node.rb', line 5736 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
5734 5735 5736 |
# File 'lib/syntax_tree/node.rb', line 5734 def comments @comments end |
#value ⇒ Object (readonly)
- String
-
the value of the keyword
5731 5732 5733 |
# File 'lib/syntax_tree/node.rb', line 5731 def value @value end |
Instance Method Details
#accept(visitor) ⇒ Object
5742 5743 5744 |
# File 'lib/syntax_tree/node.rb', line 5742 def accept(visitor) visitor.visit_kw(self) end |
#child_nodes ⇒ Object Also known as: deconstruct
5746 5747 5748 |
# File 'lib/syntax_tree/node.rb', line 5746 def child_nodes [] end |
#deconstruct_keys(_keys) ⇒ Object
5752 5753 5754 |
# File 'lib/syntax_tree/node.rb', line 5752 def deconstruct_keys(_keys) { value: value, location: location, comments: comments } end |
#format(q) ⇒ Object
5756 5757 5758 |
# File 'lib/syntax_tree/node.rb', line 5756 def format(q) q.text(value) end |