Dramatically simplified diagnostics conversion

Author: cmaglie

ls/ls.go

@@ -926,31 +926,51 @@ func (ls *INOLanguageServer) TextDocumentDidCloseNotifFromIDE(logger jsonrpc.Fun
 	}
 }
 
-func (ls *INOLanguageServer) PublishDiagnosticsNotifFromClangd(logger jsonrpc.FunctionLogger, cppParams *lsp.PublishDiagnosticsParams) {
+func (ls *INOLanguageServer) PublishDiagnosticsNotifFromClangd(logger jsonrpc.FunctionLogger, clangParams *lsp.PublishDiagnosticsParams) {
 	ls.readLock(logger, false)
 	defer ls.readUnlock(logger)
 
-	logger.Logf("%s (%d diagnostics):", cppParams.URI, len(cppParams.Diagnostics))
-	for _, diag := range cppParams.Diagnostics {
+	logger.Logf("%s (%d diagnostics):", clangParams.URI, len(clangParams.Diagnostics))
+	for _, diag := range clangParams.Diagnostics {
 		logger.Logf("  > %s - %s: %s", diag.Range.Start, diag.Severity, string(diag.Code))
 	}
 
 	// the diagnostics on sketch.cpp.ino once mapped into their
 	// .ino counter parts may span over multiple .ino files...
-	allInoParams, err := ls.clang2IdeDiagnostics(logger, cppParams)
+	allIdeParams, err := ls.clang2IdeDiagnostics(logger, clangParams)
 	if err != nil {
 		logger.Logf("Error converting diagnostics to .ino: %s", err)
 		return
 	}
 
+	// If the incoming diagnostics are from sketch.cpp.ino then...
+	if ls.clangURIRefersToIno(clangParams.URI) {
+		// ...add all the new diagnostics...
+		for ideInoURI := range allIdeParams {
+			ls.ideInoDocsWithDiagnostics[ideInoURI] = true
+		}
+
+		// .. and cleanup all previouse diagnostics that are no longer valid...
+		for ideInoURI := range ls.ideInoDocsWithDiagnostics {
+			if _, ok := allIdeParams[ideInoURI]; ok {
+				continue
+			}
+			allIdeParams[ideInoURI] = &lsp.PublishDiagnosticsParams{
+				URI:         ideInoURI,
+				Diagnostics: []lsp.Diagnostic{},
+			}
+			delete(ls.ideInoDocsWithDiagnostics, ideInoURI)
+		}
+	}
+
 	// Push back to IDE the converted diagnostics
 	logger.Logf("diagnostics to IDE:")
-	for _, inoParams := range allInoParams {
-		logger.Logf("  - %s (%d diagnostics):", inoParams.URI, len(inoParams.Diagnostics))
-		for _, diag := range inoParams.Diagnostics {
+	for _, ideParams := range allIdeParams {
+		logger.Logf("  - %s (%d diagnostics):", ideParams.URI, len(ideParams.Diagnostics))
+		for _, diag := range ideParams.Diagnostics {
 			logger.Logf("    > %s - %s: %s", diag.Range.Start, diag.Severity, diag.Code)
 		}
-		if err := ls.IDE.conn.TextDocumentPublishDiagnostics(inoParams); err != nil {
+		if err := ls.IDE.conn.TextDocumentPublishDiagnostics(ideParams); err != nil {
 			logger.Logf("Error sending diagnostics to IDE: %s", err)
 			return
 		}

ls/ls_clang_to_ide.go

@@ -1,8 +1,6 @@
 package ls
 
 import (
-	"fmt"
-
 	"github.com/arduino/arduino-language-server/sourcemapper"
 	"go.bug.st/lsp"
 	"go.bug.st/lsp/jsonrpc"
@@ -69,79 +67,35 @@ func (ls *INOLanguageServer) clang2IdeDocumentHighlight(logger jsonrpc.FunctionL
 	}, nil
 }
 
-func (ls *INOLanguageServer) clang2IdeDiagnostics(logger jsonrpc.FunctionLogger, clangDiagsParams *lsp.PublishDiagnosticsParams) ([]*lsp.PublishDiagnosticsParams, error) {
-	clangURI := clangDiagsParams.URI
-	if !ls.clangURIRefersToIno(clangURI) {
-		ideDiags := []lsp.Diagnostic{}
-		ideDiagsURI := lsp.DocumentURI{}
-		for _, clangDiag := range clangDiagsParams.Diagnostics {
-			ideURI, ideRange, err := ls.clang2IdeRangeAndDocumentURI(logger, clangURI, clangDiag.Range)
-			if err != nil {
-				return nil, err
-			}
-			if ideURI.String() == sourcemapper.NotInoURI.String() {
-				continue
-			}
-			if ideDiagsURI.String() == "" {
-				ideDiagsURI = ideURI
-			} else if ideDiagsURI.String() != ideURI.String() {
-				return nil, fmt.Errorf("unexpected URI %s: it should be %s", ideURI, ideURI)
-			}
-			ideDiag := clangDiag
-			ideDiag.Range = ideRange
-			ideDiags = append(ideDiags, ideDiag)
-		}
-		return []*lsp.PublishDiagnosticsParams{
-			{
-				URI:         ideDiagsURI,
-				Diagnostics: ideDiags,
-			},
-		}, nil
-	}
+func (ls *INOLanguageServer) clang2IdeDiagnostics(logger jsonrpc.FunctionLogger, clangDiagsParams *lsp.PublishDiagnosticsParams) (map[lsp.DocumentURI]*lsp.PublishDiagnosticsParams, error) {
+	// If diagnostics comes from sketch.ino.cpp they may refer to multiple .ino files,
+	// so we collect all of the into a map.
+	allIdeDiagsParams := map[lsp.DocumentURI]*lsp.PublishDiagnosticsParams{}
 
-	// Diagnostics coming from sketch.ino.cpp refers to all .ino files, so it must update
-	// the diagnostics list of all .ino files altogether.
-	// XXX: maybe this logic can be moved outside of this conversion function, make it much
-	// more straighforward.
-	allIdeInoDiagsParams := map[lsp.DocumentURI]*lsp.PublishDiagnosticsParams{}
-	for ideInoURI := range ls.ideInoDocsWithDiagnostics {
-		allIdeInoDiagsParams[ideInoURI] = &lsp.PublishDiagnosticsParams{
-			URI:         ideInoURI,
-			Diagnostics: []lsp.Diagnostic{},
-		}
-	}
-	ls.ideInoDocsWithDiagnostics = map[lsp.DocumentURI]bool{}
-
-	for _, clangDiag := range clangDiagsParams.Diagnostics {
-		ideURI, ideRange, err := ls.clang2IdeRangeAndDocumentURI(logger, clangURI, clangDiag.Range)
+	for _, clangDiagnostic := range clangDiagsParams.Diagnostics {
+		ideURI, ideRange, err := ls.clang2IdeRangeAndDocumentURI(logger, clangDiagsParams.URI, clangDiagnostic.Range)
 		if err != nil {
 			return nil, err
 		}
 		if ideURI.String() == sourcemapper.NotInoURI.String() {
 			continue
 		}
 
-		ideInoDiagsParams, ok := allIdeInoDiagsParams[ideURI]
+		ideDiagsParams, ok := allIdeDiagsParams[ideURI]
 		if !ok {
-			ideInoDiagsParams = &lsp.PublishDiagnosticsParams{
+			ideDiagsParams = &lsp.PublishDiagnosticsParams{
 				URI:         ideURI,
 				Diagnostics: []lsp.Diagnostic{},
 			}
-			allIdeInoDiagsParams[ideURI] = ideInoDiagsParams
+			allIdeDiagsParams[ideURI] = ideDiagsParams
 		}
 
-		ideInoDiag := clangDiag
+		ideInoDiag := clangDiagnostic
 		ideInoDiag.Range = ideRange
-		ideInoDiagsParams.Diagnostics = append(ideInoDiagsParams.Diagnostics, ideInoDiag)
-
-		ls.ideInoDocsWithDiagnostics[ideURI] = true
+		ideDiagsParams.Diagnostics = append(ideDiagsParams.Diagnostics, ideInoDiag)
 	}
 
-	ideInoDiagParams := []*lsp.PublishDiagnosticsParams{}
-	for _, v := range allIdeInoDiagsParams {
-		ideInoDiagParams = append(ideInoDiagParams, v)
-	}
-	return ideInoDiagParams, nil
+	return allIdeDiagsParams, nil
 }
 
 func (ls *INOLanguageServer) clang2IdeSymbolInformation(clangSymbolsInformation []lsp.SymbolInformation) []lsp.SymbolInformation {