Class: YARD::Parser::Ruby::AstNode

Inherits:

Array

• Object
• Array
• YARD::Parser::Ruby::AstNode

show all

Defined in:

lib/yard/parser/ruby/ast_node.rb

Overview

# AST for "if true; 5 end":
s(s(:if, s(:var_ref, s(:kw, "true")), s(s(:int, "5")), nil))

Constant Summary

Instance Attribute Summary (collapse)

• - (Object) docstring (also: #comments)

  Returns the value of attribute docstring.

• - (Object) docstring_range (also: #comments_range)

  Returns the value of attribute docstring_range.

• - (String) file

  The filename the node was parsed from.

• - (String) full_source

  The full source that the node was parsed from.

• - (Object) group

  Returns the value of attribute group.

• - (Range) line_range

  The line range in #full_source represented by the node.

• - (AstNode^?) parent

  The node's parent or nil if it is a root node.

• - (String) source (also: #to_s)

  The parse of #full_source that the node represents.

• - (Range) source_range

  The character range in #full_source represented by the node.

• - (Symbol) type

  The node's unique symbolic type.

Creating an AstNode (collapse)

• + (Class) node_class_for(type)

  Finds the node subclass that should be instantiated for a specific node type.

• - (AstNode) initialize(type, arr, opts = {}) constructor

  Creates a new AST node.

Traversing a Node (collapse)

• - (Array<AstNode>) children

  The AstNode children inside the node.

• - (AstNode, self) jump(*node_types)

  Searches through the node and all descendents and returns the first node with a type matching any of node_types, otherwise returns the original node (self).

• - (void) traverse {|self,| ... }

  Traverses the object and yields each node (including descendents) in order.

Node Meta Types (collapse)

• - (Boolean) call?

  Whether the node is a method call.

• - (Boolean) condition?

  Whether the node is a if/elsif/else condition.

• - (Boolean) kw?

  Whether the node is a keyword.

• - (Boolean) literal?

  Whether the node is a literal value.

• - (Boolean) ref?

  Whether the node is a reference (variable, constant name).

• - (Boolean) token?

  Whether the node is a token.

Getting Line Information (collapse)

• - (String) first_line

  The first line of source represented by the node.

• - (Boolean) has_line?

  Whether the node has a #line_range set.

• - (Fixnum) line

  The starting line number of the node.

Printing a Node (collapse)

• - (String) inspect

  Inspects the object.

• - (nil) pretty_print(q)

  Pretty prints the node.

• - (String) show

  The first line of source the node represents.

Methods inherited from Array

#place

131
132
133
134
135
136
137
138
139

# File 'lib/yard/parser/ruby/ast_node.rb', line 131

def initialize(type, arr, opts = {})
  super(arr)
  self.type = type
  self.line_range = opts[:line]
  self.source_range = opts[:char]
  @fallback_line = opts[:listline]
  @fallback_source = opts[:listchar]
  @token = true if opts[:token]
end

41
42
43

# File 'lib/yard/parser/ruby/ast_node.rb', line 41

def docstring
  @docstring
end

41
42
43

# File 'lib/yard/parser/ruby/ast_node.rb', line 41

def docstring_range
  @docstring_range
end

68
69
70
71

# File 'lib/yard/parser/ruby/ast_node.rb', line 68

def file
  return parent.file if parent
  @file
end

74
75
76
77
78

# File 'lib/yard/parser/ruby/ast_node.rb', line 74

def full_source
  return parent.full_source if parent
  return @full_source if @full_source
  return IO.read(@file) if file && File.exist?(file)
end

41
42
43

# File 'lib/yard/parser/ruby/ast_node.rb', line 41

def group
  @group
end

62
63
64
65

# File 'lib/yard/parser/ruby/ast_node.rb', line 62

def line_range
  reset_line_info unless @line_range
  @line_range
end

51
52
53

# File 'lib/yard/parser/ruby/ast_node.rb', line 51

def parent
  @parent
end

81
82
83
84

# File 'lib/yard/parser/ruby/ast_node.rb', line 81

def source
  return parent.full_source[source_range] if parent
  full_source
end

55
56
57
58

# File 'lib/yard/parser/ruby/ast_node.rb', line 55

def source_range
  reset_line_info unless @source_range
  @source_range
end

48
49
50

# File 'lib/yard/parser/ruby/ast_node.rb', line 48

def type
  @type
end

103
104
105
106
107
108
109
110
111
112
113
114
115
116

# File 'lib/yard/parser/ruby/ast_node.rb', line 103

def self.node_class_for(type)
  case type
  when :params
    ParameterNode
  when :call, :fcall, :command, :command_call
    MethodCallNode
  when :if, :elsif, :if_mod, :unless, :unless_mod
    ConditionalNode
  when /_ref\Z/
    ReferenceNode
  else
    AstNode
  end
end

217
218
219

# File 'lib/yard/parser/ruby/ast_node.rb', line 217

def call?
  false
end

176
177
178

# File 'lib/yard/parser/ruby/ast_node.rb', line 176

def children
  @children ||= select {|e| AstNode === e }
end

222
223
224

# File 'lib/yard/parser/ruby/ast_node.rb', line 222

def condition?
  false
end

239
240
241

# File 'lib/yard/parser/ruby/ast_node.rb', line 239

def first_line
  full_source.split(/\r?\n/)[line - 1].strip
end

229
230
231

# File 'lib/yard/parser/ruby/ast_node.rb', line 229

def has_line?
  @line_range ? true : false
end

285
286
287
288

# File 'lib/yard/parser/ruby/ast_node.rb', line 285

def inspect 
  typeinfo = type && type != :list ? ':' + type.to_s + ', ' : ''
  's(' + typeinfo + map(&:inspect).join(", ") + ')'
end

ast = YARD.parse_string("if true; def x; end end").ast
ast.jump(:def)
# => s(:def, s(:ident, "x"), s(:params, nil, nil, nil, nil, 
#      nil), s(s(:void_stmt, )))

ast = YARD.parse_string("class X; def y; end end")
ast.jump(:def, :class).first
# => 

ast = YARD.parse("def x; end")
ast.jump(:def)

170
171
172
173

# File 'lib/yard/parser/ruby/ast_node.rb', line 170

def jump(*node_types)
  traverse {|child| return(child) if node_types.include?(child.type) }
  self
end

212
213
214

# File 'lib/yard/parser/ruby/ast_node.rb', line 212

def kw?
  @kw ||= KEYWORDS.has_key?(type)
end

234
235
236

# File 'lib/yard/parser/ruby/ast_node.rb', line 234

def line
  line_range && line_range.first
end

207
208
209

# File 'lib/yard/parser/ruby/ast_node.rb', line 207

def literal?
  @literal ||= type =~ /_literal$/ ? true : false
end

251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282

# File 'lib/yard/parser/ruby/ast_node.rb', line 251

def pretty_print(q)
  objs = [*self.dup, :__last__]
  objs.unshift(type) if type && type != :list

  options = {}
  if @docstring
    options[:docstring] = docstring
  end
  if @source_range || @line_range
    options[:line] = line_range
    options[:source] = source_range
  end
  objs.pop if options.size == 0

  q.group(3, 's(', ')') do
    q.seplist(objs, nil, :each) do |v| 
      if v == :__last__
        q.seplist(options, nil, :each) do |k, v2| 
          q.group(3) do 
            q.text k
            q.group(3) do 
              q.text ': '
              q.pp v2 
            end
          end
        end
      else
        q.pp v 
      end
    end
  end
end

202
203
204

# File 'lib/yard/parser/ruby/ast_node.rb', line 202

def ref?
  false
end

246
247
248

# File 'lib/yard/parser/ruby/ast_node.rb', line 246

def show
  "\t#{line}: #{first_line}"
end

196
197
198

# File 'lib/yard/parser/ruby/ast_node.rb', line 196

def token?
  @token
end

185
186
187
188
189
190
191

# File 'lib/yard/parser/ruby/ast_node.rb', line 185

def traverse
  nodes = [self]
  nodes.each.with_index do |node, index|
    yield node
    nodes.insert index+1, *node.children
  end
end