fix: compatibility with legacy LSPs who return SymbolInformation

Author: Hoblovski

lang/lsp/lsp.go

@@ -180,25 +180,22 @@ type TextDocumentItem struct {
 	Definitions map[Position][]Location   `json:"-"`
 }
 
-type HierarchicalDocumentSymbol struct {
-	Name           string                       `json:"name"`
-	Detail         string                       `json:"detail,omitempty"`
-	Kind           SymbolKind                   `json:"kind"`
-	Range          Range                        `json:"range"`
-	SelectionRange Range                        `json:"selectionRange"`
-	Children       []HierarchicalDocumentSymbol `json:"children,omitempty"`
-}
-
 type DocumentSymbol struct {
 	Name     string            `json:"name"`
 	Kind     SymbolKind        `json:"kind"`
 	Tags     []json.RawMessage `json:"tags"`
-	Location Location          `json:"location"`
 	Children []*DocumentSymbol `json:"children"`
 	Text     string            `json:"text"`
 	Tokens   []Token           `json:"tokens"`
 	Node     *sitter.Node      `json:"-"`
 	Role     SymbolRole        `json:"-"`
+
+	// Older LSPs might return SymbolInformation[] which have `Location`.
+	// Newer LSPs return DocumentSymbol[] which have `Range` and `SelectionRange`.
+	// ABCoder uses `Location`, and converts `Range` to `Location` when needed.
+	Location       Location `json:"location"`
+	Range          *Range   `json:"range"`
+	SelectionRange *Range   `json:"selectionRange"`
 }
 
 type TextDocumentPositionParams struct {

lang/lsp/lsp_methods.go

@@ -16,7 +16,6 @@ package lsp
 
 import (
 	"context"
-	"encoding/json"
 	"fmt"
 	"math"
 	"os"
@@ -64,19 +63,38 @@ func (cli *LSPClient) DidOpen(ctx context.Context, file DocumentURI) (*TextDocum
 	return f, nil
 }
 
-func flattenHierarchicalDocumentSymbols(symbols []HierarchicalDocumentSymbol, uri DocumentURI) []DocumentSymbol {
-	var result []DocumentSymbol
+func flattenDocumentSymbols(symbols []*DocumentSymbol, uri DocumentURI) []*DocumentSymbol {
+	var result []*DocumentSymbol
 	for _, sym := range symbols {
-		result = append(result, DocumentSymbol{
-			Name: sym.Name,
-			Kind: sym.Kind,
-			Location: Location{
+		var location Location
+		if sym.Range != nil {
+			location = Location{
 				URI:   uri,
-				Range: sym.Range,
-			},
-		})
+				Range: *sym.Range,
+			}
+		} else {
+			location = sym.Location
+		}
+		flatSymbol := DocumentSymbol{
+			// copy
+			Name:     sym.Name,
+			Kind:     sym.Kind,
+			Tags:     sym.Tags,
+			Text:     sym.Text,
+			Tokens:   sym.Tokens,
+			Node:     sym.Node,
+			Children: sym.Children,
+			// new
+			Location: location,
+			// empty
+			Role:           0,
+			Range:          nil,
+			SelectionRange: nil,
+		}
+		result = append(result, &flatSymbol)
+
 		if len(sym.Children) > 0 {
-			childSymbols := flattenHierarchicalDocumentSymbols(sym.Children, uri)
+			childSymbols := flattenDocumentSymbols(sym.Children, uri)
 			result = append(result, childSymbols...)
 		}
 	}
@@ -98,18 +116,15 @@ func (cli *LSPClient) DocumentSymbols(ctx context.Context, file DocumentURI) (ma
 			URI: uri,
 		},
 	}
-	var respHierarchical []HierarchicalDocumentSymbol
-	if err := cli.Call(ctx, "textDocument/documentSymbol", req, &respHierarchical); err != nil {
+	var resp []*DocumentSymbol
+	if err := cli.Call(ctx, "textDocument/documentSymbol", req, &resp); err != nil {
 		return nil, err
 	}
-	if s, err := json.MarshalIndent(respHierarchical, "", "  "); err == nil {
-		_ = os.WriteFile("docsyms_hie.json", s, 0644)
-	}
-	resp := flattenHierarchicalDocumentSymbols(respHierarchical, file)
+	respFlatten := flattenDocumentSymbols(resp, file)
 	// cache symbols
-	f.Symbols = make(map[Range]*DocumentSymbol, len(resp))
-	for i := range resp {
-		s := &resp[i]
+	f.Symbols = make(map[Range]*DocumentSymbol, len(respFlatten))
+	for i := range respFlatten {
+		s := respFlatten[i]
 		f.Symbols[s.Location.Range] = s
 	}
 	return f.Symbols, nil