Psych::TreeBuilder

Class

This class works in conjunction with Psych::Parser to build an in-memory parse tree that represents a YAML document.

Example

parser = Psych::Parser.new Psych::TreeBuilder.new
parser.parse('--- foo')
tree = parser.handler.root

See Psych::Handler for documentation on the event methods used in this class.

Attributes

root

Read

Returns the root node for the built tree

Class Methods

new

ext/psych/lib/psych/tree_builder.rb View on GitHub

          
            # File tmp/rubies/ruby-3.4.0-preview1/ext/psych/lib/psych/tree_builder.rb, line 22
def initialize
  @stack = []
  @last  = nil
  @root  = nil

  @start_line   = nil
  @start_column = nil
  @end_line     = nil
  @end_column   = nil
end

Create a new TreeBuilder instance

Instance Methods

alias(anchor)

ext/psych/lib/psych/tree_builder.rb View on GitHub

          
            # File tmp/rubies/ruby-3.4.0-preview1/ext/psych/lib/psych/tree_builder.rb, line 103
def alias anchor
  a = Nodes::Alias.new(anchor)
  set_location(a)
  @last.children << a
  a
end

No documentation available

end_document(implicit_end = !streaming?)

ext/psych/lib/psych/tree_builder.rb View on GitHub

          
            # File tmp/rubies/ruby-3.4.0-preview1/ext/psych/lib/psych/tree_builder.rb, line 77
def end_document implicit_end = !streaming?
  @last.implicit_end = implicit_end
  n = pop
  set_end_location(n)
  n
end

Handles end_document events with version, tag_directives, and implicit styling.

See Psych::Handler#start_document

end_stream

ext/psych/lib/psych/tree_builder.rb View on GitHub

          
            # File tmp/rubies/ruby-3.4.0-preview1/ext/psych/lib/psych/tree_builder.rb, line 90
def end_stream
  n = pop
  set_end_location(n)
  n
end

No documentation available

event_location(start_line, start_column, end_line, end_column)

ext/psych/lib/psych/tree_builder.rb View on GitHub

          
            # File tmp/rubies/ruby-3.4.0-preview1/ext/psych/lib/psych/tree_builder.rb, line 33
def event_location(start_line, start_column, end_line, end_column)
  @start_line   = start_line
  @start_column = start_column
  @end_line     = end_line
  @end_column   = end_column
end

No documentation available

pop

ext/psych/lib/psych/tree_builder.rb View on GitHub

          
            # File tmp/rubies/ruby-3.4.0-preview1/ext/psych/lib/psych/tree_builder.rb, line 116
def pop
  x = @stack.pop
  @last = @stack.last
  x
end

No documentation available

push(value)

ext/psych/lib/psych/tree_builder.rb View on GitHub

          
            # File tmp/rubies/ruby-3.4.0-preview1/ext/psych/lib/psych/tree_builder.rb, line 111
def push value
  @stack.push value
  @last = value
end

No documentation available

scalar(value, anchor, tag, plain, quoted, style)

ext/psych/lib/psych/tree_builder.rb View on GitHub

          
            # File tmp/rubies/ruby-3.4.0-preview1/ext/psych/lib/psych/tree_builder.rb, line 96
def scalar value, anchor, tag, plain, quoted, style
  s = Nodes::Scalar.new(value,anchor,tag,plain,quoted,style)
  set_location(s)
  @last.children << s
  s
end

No documentation available

set_end_location(node)

ext/psych/lib/psych/tree_builder.rb View on GitHub

          
            # File tmp/rubies/ruby-3.4.0-preview1/ext/psych/lib/psych/tree_builder.rb, line 132
def set_end_location(node)
  node.end_line   = @end_line
  node.end_column = @end_column
end

No documentation available

set_location(node)

ext/psych/lib/psych/tree_builder.rb View on GitHub

          
            # File tmp/rubies/ruby-3.4.0-preview1/ext/psych/lib/psych/tree_builder.rb, line 122
def set_location(node)
  set_start_location(node)
  set_end_location(node)
end

No documentation available

set_start_location(node)

ext/psych/lib/psych/tree_builder.rb View on GitHub

          
            # File tmp/rubies/ruby-3.4.0-preview1/ext/psych/lib/psych/tree_builder.rb, line 127
def set_start_location(node)
  node.start_line   = @start_line
  node.start_column = @start_column
end

No documentation available

start_document(version, tag_directives, implicit)

ext/psych/lib/psych/tree_builder.rb View on GitHub

          
            # File tmp/rubies/ruby-3.4.0-preview1/ext/psych/lib/psych/tree_builder.rb, line 65
def start_document version, tag_directives, implicit
  n = Nodes::Document.new version, tag_directives, implicit
  set_start_location(n)
  @last.children << n
  push n
end

Handles start_document events with version, tag_directives, and implicit styling.

See Psych::Handler#start_document

start_stream(encoding)

ext/psych/lib/psych/tree_builder.rb View on GitHub

          
            # File tmp/rubies/ruby-3.4.0-preview1/ext/psych/lib/psych/tree_builder.rb, line 84
def start_stream encoding
  @root = Nodes::Stream.new(encoding)
  set_start_location(@root)
  push @root
end

No documentation available