Class: Furnace::AST::Node

Inherits:
Object
  • Object
show all
Defined in:
lib/furnace/ast/node.rb

Overview

Node is an immutable class, instances of which represent abstract syntax tree nodes. It combines semantic information (i.e. anything that affects the algorithmic properties of a program) with meta-information (line numbers or compiler intermediates).

Notes on inheritance

The distinction between semantics and metadata is important. Complete semantic information should be contained within just the #type and #children of a Node instance; in other words, if an AST was to be stripped of all meta-information, it should remain a valid AST which could be successfully processed to yield a result with the same algorithmic properties.

Thus, Node should never be inherited in order to define methods which affect or return semantic information, such as getters for class_name, superclass and body in the case of a hypothetical ClassNode. The correct solution is to use a generic Node with a #type of :class and three children. See also Processor for tips on working with such ASTs.

On the other hand, Node can and should be inherited to define application-specific metadata (see also #initialize) or customize the printing format. It is expected that an application would have one or two such classes and use them across the entire codebase.

The rationale for this pattern is extensibility and maintainability. Unlike static ones, dynamic languages do not require the presence of a predefined, rigid structure, nor does it improve dispatch efficiency, and while such a structure can certainly be defined, it does not add any value but incurs a maintaining cost. For example, extending the AST even with a transformation-local temporary node type requires making globally visible changes to the codebase.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(type, children = [], properties = {}) ⇒ Node

Constructs a new instance of Node.

The arguments type and children are converted with to_sym and to_a respectively. Additionally, the result of converting children is frozen. While mutating the arguments is generally considered harmful, the most common case is to pass an array literal to the constructor. If your code does not expect the argument to be frozen, use #dup.

The properties hash is passed to #assign_properties.



57
58
59
60
61
62
63
 
# File 'lib/furnace/ast/node.rb', line 57

def initialize(type, children=[], properties={})
  @type, @children = type.to_sym, children.to_a.freeze

  assign_properties(properties)

  freeze
end

Instance Attribute Details

#children ⇒ Array (readonly)

Returns the children of this node. The returned value is frozen.

Returns:

  • (Array) 


46
47
48
 
# File 'lib/furnace/ast/node.rb', line 46

def children
  @children
end

#type ⇒ Symbol (readonly)

Returns the type of this node.

Returns:

  • (Symbol) 


41
42
43
 
# File 'lib/furnace/ast/node.rb', line 41

def type
  @type
end

Instance Method Details

#==(other) ⇒ Boolean

Compares self to other, possibly converting with to_ast. Only type and children are compared; metadata is deliberately ignored.

Returns:

  • (Boolean) 


114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/furnace/ast/node.rb', line 114

def ==(other)
  if equal?(other)
    true
  elsif other.respond_to? :to_ast
    other = other.to_ast
    other.type == self.type &&
      other.children == self.children
  else
    false
  end
end

#assign_properties(properties) ⇒ nil (protected)

By default, each entry in the properties hash is assigned to a local variable in this instance of Node. A subclass should define attribute readers for such variables. The values passed in the hash are not frozen or whitelisted; such behavior can also be implemented\ by subclassing Node and overriding this method.

Returns:

  • (nil) 


72
73
74
75
76
77
78
 
# File 'lib/furnace/ast/node.rb', line 72

def assign_properties(properties)
  properties.each do |name, value|
    instance_variable_set :"@#{name}", value
  end

  nil
end

#fancy_type ⇒ String (protected)

Returns @type with all underscores replaced by dashes. This allows to write symbol literals without quotes in Ruby sources and yet have nicely looking s-expressions.

Returns:

  • (String) 


183
184
185
 
# File 'lib/furnace/ast/node.rb', line 183

def fancy_type
  @type.to_s.gsub('_', '-')
end

#to_ast ⇒ AST::Node

Returns self.

Returns:



172
173
174
 
# File 'lib/furnace/ast/node.rb', line 172

def to_ast
  self
end

#to_s ⇒ String

Converts self to a concise s-expression, omitting any children.

Returns:

  • (String) 


129
130
131
 
# File 'lib/furnace/ast/node.rb', line 129

def to_s
  "(#{fancy_type} ...)"
end

#to_sexp(indent = 0) ⇒ String Also known as: inspect

Converts self to a pretty-printed s-expression.

Parameters:

  • indent (Integer) (defaults to: 0) —

    Base indentation level.

Returns:

  • (String) 


137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/furnace/ast/node.rb', line 137

def to_sexp(indent=0)
  indented = "  " * indent
  sexp = "#{indented}(#{fancy_type}"

  first_node_child = children.index do |child|
    child.is_a?(Node) || child.is_a?(Array)
  end || children.count

  children.each_with_index do |child, idx|
    if child.is_a?(Node) && idx >= first_node_child
      sexp << "\n#{child.to_sexp(indent + 1)}"
    elsif child.is_a?(Hash)
      sexp << " {\n"
      child.each do |key, value|
        if value.is_a?(Node)
          pretty_value = value.to_sexp(indent + 2).lstrip
        else
          pretty_value = value.inspect
        end

        sexp << "#{indented}    #{key.inspect} => #{pretty_value}\n"
      end
      sexp << "#{indented}  }"
    else
      sexp << " #{child.inspect}"
    end
  end

  sexp << ")"

  sexp
end

#updated(type = nil, children = nil, properties = nil) ⇒ AST::Node

Returns a new instance of Node where non-nil arguments replace the corresponding fields of self.

For example, Node.new(:foo, [ 1, 2 ]).updated(:bar) would yield (bar 1 2), and Node.new(:foo, [ 1, 2 ]).updated(nil, []) would yield (foo).

If the resulting node would be identical to self, does nothing.

Parameters:

  • type (Symbol, nil) (defaults to: nil)
  • children (Array, nil) (defaults to: nil)
  • properties (Hash, nil) (defaults to: nil)

Returns:



96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/furnace/ast/node.rb', line 96

def updated(type=nil, children=nil, properties=nil)
  new_type       = type       || @type
  new_children   = children   || @children
  new_properties = properties || {}

  if @type == new_type &&
      @children == new_children &&
      properties.nil?
    self
  else
    dup.send :initialize, new_type, new_children, new_properties
  end
end