Class: CodeTools::AST::Node

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

Defined Under Namespace

Classes: TransformState

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(line) ⇒ Node

Returns a new instance of Node.



48
49
50
 
# File 'lib/rubinius/ast/node.rb', line 48

def initialize(line)
  @line = line
end

Instance Attribute Details

#line ⇒ Object

Returns the value of attribute line.



6
7
8
 
# File 'lib/rubinius/ast/node.rb', line 6

def line
  @line
end

Class Method Details

.match_arguments?(arguments, count) ⇒ Boolean

Returns:

  • (Boolean) 


37
38
39
40
41
42
43
44
45
46
 
# File 'lib/rubinius/ast/node.rb', line 37

def self.match_arguments?(arguments, count)
  case arguments
  when ArrayLiteral
    arguments.body.size == count
  when nil
    count == 0
  else
    false
  end
end

.match_send?(node, receiver, method, name) ⇒ Boolean

Returns:

  • (Boolean) 


31
32
33
34
35
 
# File 'lib/rubinius/ast/node.rb', line 31

def self.match_send?(node, receiver, method, name)
  node.kind_of? ConstantAccess and
    node.name == receiver and
    method == name
end

.transform(category, name, comment) ⇒ Object 



8
9
10
11
12
13
 
# File 'lib/rubinius/ast/node.rb', line 8

def self.transform(category, name, comment)
  Transforms.register category, name, self
  @transform_name = name
  @transform_comment = comment
  @transform_kind = :call
end

.transform_comment ⇒ Object 



19
20
21
 
# File 'lib/rubinius/ast/node.rb', line 19

def self.transform_comment
  @transform_comment
end

.transform_kind ⇒ Object 



23
24
25
 
# File 'lib/rubinius/ast/node.rb', line 23

def self.transform_kind
  @transform_kind
end

.transform_kind=(k) ⇒ Object 



27
28
29
 
# File 'lib/rubinius/ast/node.rb', line 27

def self.transform_kind=(k)
  @transform_kind = k
end

.transform_name ⇒ Object 



15
16
17
 
# File 'lib/rubinius/ast/node.rb', line 15

def self.transform_name
  @transform_name
end

Instance Method Details

#ascii_graph ⇒ Object 



121
122
123
 
# File 'lib/rubinius/ast/node.rb', line 121

def ascii_graph
  AsciiGrapher.new(self).print
end

#attributes ⇒ Object

Yields each attribute and its name to the block.



186
187
188
189
190
191
192
 
# File 'lib/rubinius/ast/node.rb', line 186

def attributes
  instance_variables.each do |var|
    child = instance_variable_get var
    name = var.to_s[1..-1]
    yield child, name
  end
end

#bytecode(g) ⇒ Object 



91
92
 
# File 'lib/rubinius/ast/node.rb', line 91

def bytecode(g)
end

#children ⇒ Object

Yields each child of this Node to the block. Additionally, for any attribute that is an Array, yields each element that is a Node.



143
144
145
146
147
148
149
150
151
152
 
# File 'lib/rubinius/ast/node.rb', line 143

def children
  instance_variables.each do |var|
    child = instance_variable_get var
    if child.kind_of? Node
      yield child
    elsif child.kind_of? Array
      child.each { |x| yield x if x.kind_of? Node }
    end
  end
end

#defined(g) ⇒ Object 



94
95
96
97
98
99
100
101
102
 
# File 'lib/rubinius/ast/node.rb', line 94

def defined(g)
  g.push_rubinius
  g.push_scope
  g.send :active_path, 0
  g.push @line
  g.send :unrecognized_defined, 2
  g.pop
  g.push :nil
end

#new_block_generator(g, arguments) ⇒ Object 



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/rubinius/ast/node.rb', line 56

def new_block_generator(g, arguments)
  blk = g.class.new
  blk.name = g.state.name || :__block__
  blk.file = g.file
  blk.for_block = true

  blk.required_args = arguments.required_args
  blk.post_args = arguments.post_args
  blk.total_args = arguments.total_args
  blk.splat_index = arguments.splat_index
  blk.block_index = arguments.block_index
  blk.arity = arguments.arity
  blk.keywords = arguments.keywords.entries if arguments.keywords

  blk
end

#new_generator(g, name, arguments = nil) ⇒ Object 



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/rubinius/ast/node.rb', line 73

def new_generator(g, name, arguments=nil)
  meth = g.class.new
  meth.name = name
  meth.file = g.file

  if arguments
    meth.required_args = arguments.required_args
    meth.post_args = arguments.post_args
    meth.total_args = arguments.total_args
    meth.splat_index = arguments.splat_index
    meth.block_index = arguments.block_index
    meth.arity = arguments.arity
    meth.keywords = arguments.keywords.entries if arguments.keywords
  end

  meth
end

#node_name ⇒ Object

The equivalent of Some::Module.demodulize.underscore in ActiveSupport. The code is shamelessly borrowed as well.



156
157
158
159
160
161
162
 
# File 'lib/rubinius/ast/node.rb', line 156

def node_name
  name = self.class.name.gsub(/^.*::/, '')
  name.gsub!(/([A-Z]+)([A-Z][a-z])/,'\1_\2')
  name.gsub!(/([a-z\d])([A-Z])/,'\1_\2')
  name.downcase!
  name
end

#or_bytecode(g) ⇒ Object

Called if used as the lhs of an ||=. Expected to yield if the value was not found, so the bytecode for it to be emitted.



127
128
129
130
131
132
133
134
135
 
# File 'lib/rubinius/ast/node.rb', line 127

def or_bytecode(g)
  found = g.new_label
  bytecode(g)
  g.dup
  g.git found
  g.pop
  yield
  found.set!
end

#pos(g) ⇒ Object 



52
53
54
 
# File 'lib/rubinius/ast/node.rb', line 52

def pos(g)
  g.set_line @line
end

#set_child(name, node) ⇒ Object

Called by #transform to update the child of a Node instance. The default just calls the attr_accessor for the child. However, Node subclasses that must synchronize other internal state can override this method.



181
182
183
 
# File 'lib/rubinius/ast/node.rb', line 181

def set_child(name, node)
  send :"#{name}=", node
end

#to_sexp ⇒ Object 



137
138
139
 
# File 'lib/rubinius/ast/node.rb', line 137

def to_sexp
  [:node, self.class.name]
end

#transform(visitor, parent = nil, state = nil) ⇒ Object

A fixed-point algorithm for transforming an AST with a visitor. The traversal is top-down. The visitor object’s method corresponding to each node (see #node_name) is called for each node, passing the node and its parent.

To replace the node in the tree, the visitor method should return a new node; otherwise, return the existing node. The visitor is free to change values in the node, but substituting a node causes the entire tree to be walked repeatedly until no modifications are made.



203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
 
# File 'lib/rubinius/ast/node.rb', line 203

def transform(visitor, parent=nil, state=nil)
  state ||= TransformState.new

  node = visitor.send :"node_#{node_name}", self, parent
  state.modify unless equal? node

  node.attributes do |attr, name|
    if attr.kind_of? Node
      child = attr.transform visitor, node, state
      unless attr.equal? child
        state.modify
        node.set_child name, child
      end
    elsif attr.kind_of? Array
      attr.each_with_index do |x, i|
        if x.kind_of? Node
          child = x.transform visitor, node, state
          unless x.equal? child
            state.modify
            attr[i] = child
          end
        end
      end
    end
  end

  # Repeat the walk until the tree is not modified.
  if parent.nil? and state.modified?
    state.unmodify
    node = transform visitor, nil, state
  end

  node
end

#value_defined(g, f) ⇒ Object 



104
105
106
 
# File 'lib/rubinius/ast/node.rb', line 104

def value_defined(g, f)
  bytecode(g)
end

#visit(visitor, parent = nil) ⇒ Object

Supports the Visitor pattern on a tree of Nodes. The visitor should be an object that responds to methods named after the Node subclasses. The method called is determined by the #node_name method. Passes both the node and its parent so that the visitor can maintain nesting information if desired.

The #visit implements a read-only traversal of the tree. To modify the tree, see the #transform methed.



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

def visit(visitor, parent=nil)
  visitor.__send__ self.node_name, self, parent
  children { |c| c.visit visitor, self }
end

#walk(arg = true, &block) ⇒ Object

This method implements a sort of tree iterator, yielding each Node instance to the provided block with the first argument to #walk. If the block returns a non-true value, the walk is terminated.

This method is really an iterator, not a Visitor pattern.



113
114
115
116
117
118
119
 
# File 'lib/rubinius/ast/node.rb', line 113

def walk(arg=true, &block)
  children do |child|
    if ch_arg = block.call(arg, child)
      child.walk(ch_arg, &block)
    end
  end
end