Class: SyntaxTree::Binary

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

Overview

Binary represents any expression that involves two sub-expressions with an operator in between. This can be something that looks like a mathematical operation:

1 + 1

but can also be something like pushing a value onto an array:

array << value

Instance Attribute Summary collapse

Attributes inherited from Node

#location

Instance Method Summary collapse

Methods inherited from Node

#construct_keys, #end_char, #pretty_print, #start_char, #to_json, #to_mermaid

Constructor Details

#initialize(left:, operator:, right:, location:) ⇒ Binary

Returns a new instance of Binary.



2052
2053
2054
2055
2056
2057
2058
 
# File 'lib/syntax_tree/node.rb', line 2052

def initialize(left:, operator:, right:, location:)
  @left = left
  @operator = operator
  @right = right
  @location = location
  @comments = []
end

Instance Attribute Details

#comments ⇒ Object (readonly)

Array[ Comment | EmbDoc ]

the comments attached to this node



2050
2051
2052
 
# File 'lib/syntax_tree/node.rb', line 2050

def comments
  @comments
end

#left ⇒ Object (readonly)

Node

the left-hand side of the expression



2041
2042
2043
 
# File 'lib/syntax_tree/node.rb', line 2041

def left
  @left
end

#operator ⇒ Object (readonly)

Symbol

the operator used between the two expressions



2044
2045
2046
 
# File 'lib/syntax_tree/node.rb', line 2044

def operator
  @operator
end

#right ⇒ Object (readonly)

Node

the right-hand side of the expression



2047
2048
2049
 
# File 'lib/syntax_tree/node.rb', line 2047

def right
  @right
end

Instance Method Details

#===(other) ⇒ Object 



2123
2124
2125
2126
 
# File 'lib/syntax_tree/node.rb', line 2123

def ===(other)
  other.is_a?(Binary) && left === other.left &&
    operator === other.operator && right === other.right
end

#accept(visitor) ⇒ Object 



2060
2061
2062
 
# File 'lib/syntax_tree/node.rb', line 2060

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

#child_nodes ⇒ Object Also known as: deconstruct 



2064
2065
2066
 
# File 'lib/syntax_tree/node.rb', line 2064

def child_nodes
  [left, right]
end

#copy(left: nil, operator: nil, right: nil, location: nil) ⇒ Object 



2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
 
# File 'lib/syntax_tree/node.rb', line 2068

def copy(left: nil, operator: nil, right: nil, location: nil)
  node =
    Binary.new(
      left: left || self.left,
      operator: operator || self.operator,
      right: right || self.right,
      location: location || self.location
    )

  node.comments.concat(comments.map(&:copy))
  node
end

#deconstruct_keys(_keys) ⇒ Object 



2083
2084
2085
2086
2087
2088
2089
2090
2091
 
# File 'lib/syntax_tree/node.rb', line 2083

def deconstruct_keys(_keys)
  {
    left: left,
    operator: operator,
    right: right,
    location: location,
    comments: comments
  }
end

#format(q) ⇒ Object 



2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
 
# File 'lib/syntax_tree/node.rb', line 2093

def format(q)
  power = operator == :**

  q.group do
    q.group { q.format(left) }
    q.text(" ") unless power

    if operator != :<<
      q.group do
        q.text(operator.name)
        q.indent do
          power ? q.breakable_empty : q.breakable_space
          q.format(right)
        end
      end
    elsif left.is_a?(Binary) && left.operator == :<<
      q.group do
        q.text(operator.name)
        q.indent do
          power ? q.breakable_empty : q.breakable_space
          q.format(right)
        end
      end
    else
      q.text("<< ")
      q.format(right)
    end
  end
end