Contents

# typed: strict
# frozen_string_literal: true

module RubyLsp
  module Requests
    # Show syntax tree is a custom [LSP
    # request](https://microsoft.github.io/language-server-protocol/specification#requestMessage) that displays the AST
    # for the current document or for the current selection in a new tab.
    class ShowSyntaxTree < Request
      extend T::Sig

      sig { params(document: RubyDocument, range: T.nilable(T::Hash[Symbol, T.untyped])).void }
      def initialize(document, range)
        super()
        @document = document
        @range = range
        @tree = T.let(document.parse_result.value, Prism::ProgramNode)
      end

      sig { override.returns(String) }
      def perform
        return ast_for_range if @range

        output_string = +""
        PP.pp(@tree, output_string)
        output_string
      end

      private

      sig { returns(String) }
      def ast_for_range
        range = T.must(@range)
        start_char, end_char = @document.find_index_by_position(range[:start], range[:end])

        queue = @tree.statements.body.dup
        found_nodes = []

        until queue.empty?
          node = queue.shift
          next unless node

          loc = node.location

          # If the node is fully covered by the selection, then we found one of the nodes to be displayed and don't want
          # to continue descending into its children
          if (start_char..end_char).cover?(loc.start_offset..loc.end_offset)
            found_nodes << node
          else
            T.unsafe(queue).unshift(*node.child_nodes)
          end
        end

        found_nodes.map do |node|
          output_string = +""
          PP.pp(node, output_string)
          output_string
        end.join("\n")
      end
    end
  end
end

Version data entries

5 entries across 5 versions & 1 rubygems

Version	Path
ruby-lsp-0.23.6	lib/ruby_lsp/requests/show_syntax_tree.rb
ruby-lsp-0.23.5	lib/ruby_lsp/requests/show_syntax_tree.rb
ruby-lsp-0.23.4	lib/ruby_lsp/requests/show_syntax_tree.rb
ruby-lsp-0.23.3	lib/ruby_lsp/requests/show_syntax_tree.rb
ruby-lsp-0.23.2	lib/ruby_lsp/requests/show_syntax_tree.rb