Factored configuration paramaters for the language server

Author: cmaglie

ls/builder.go

@@ -159,8 +159,10 @@ func (ls *INOLanguageServer) generateBuildEnvironment(ctx context.Context, logge
 	// Extract all build information from language server status
 	ls.readLock(logger, false)
 	sketchRoot := ls.sketchRoot
-	fqbn := ls.config.SelectedBoard.Fqbn
+	fqbn := ls.config.Fqbn
 	buildPath := ls.buildPath
+	cliPath := ls.config.CliPath
+	cliConfigPath := ls.config.CliConfigPath
 	type overridesFile struct {
 		Overrides map[string]string `json:"overrides"`
 	}
@@ -176,7 +178,7 @@ func (ls *INOLanguageServer) generateBuildEnvironment(ctx context.Context, logge
 	ls.readUnlock(logger)
 
 	var success bool
-	if true {
+	if cliPath == nil {
 		// Establish a connection with the gRPC server, started with the command:
 		// arduino-cli daemon
 		conn, err := grpc.Dial("localhost:50051", grpc.WithInsecure(), grpc.WithBlock())
@@ -246,8 +248,8 @@ func (ls *INOLanguageServer) generateBuildEnvironment(ctx context.Context, logge
 		}
 
 		// Run arduino-cli to perform the build
-		args := []string{globalCliPath,
-			"--config-file", globalCliConfigPath,
+		args := []string{cliPath.String(),
+			"--config-file", cliConfigPath.String(),
 			"compile",
 			"--fqbn", fqbn,
 			"--only-compilation-database",

ls/ls.go

@@ -24,30 +24,13 @@ import (
 	"go.bug.st/lsp/textedits"
 )
 
-var globalCliPath string
-var globalCliConfigPath string
-var globalClangdPath string
-var globalFormatterConf *paths.Path
-var enableLogging bool
-
-// Setup initializes global variables.
-func Setup(cliPath, cliConfigPath, clangdPath, formatFilePath string, _enableLogging bool) {
-	globalCliPath = cliPath
-	globalCliConfigPath = cliConfigPath
-	globalClangdPath = clangdPath
-	if formatFilePath != "" {
-		globalFormatterConf = paths.New(formatFilePath)
-	}
-	enableLogging = _enableLogging
-}
-
 // INOLanguageServer is a JSON-RPC handler that delegates messages to clangd.
 type INOLanguageServer struct {
+	config *Config
 	IDE    *IDELSPServer
 	Clangd *ClangdLSPClient
 
-	progressHandler *ProgressProxyHandler
-
+	progressHandler         *ProgressProxyHandler
 	closing                 chan bool
 	clangdStarted           *sync.Cond
 	dataMux                 sync.RWMutex
@@ -62,20 +45,16 @@ type INOLanguageServer struct {
 	trackedInoDocs          map[string]lsp.TextDocumentItem
 	inoDocsWithDiagnostics  map[lsp.DocumentURI]bool
 	sketchRebuilder         *SketchRebuilder
-
-	config BoardConfig
 }
 
-// BoardConfig describes the board and port selected by the user.
-type BoardConfig struct {
-	SelectedBoard Board  `json:"selectedBoard"`
-	SelectedPort  string `json:"selectedPort"`
-}
-
-// Board structure.
-type Board struct {
-	Name string `json:"name"`
-	Fqbn string `json:"fqbn"`
+// Config describes the language server configuration.
+type Config struct {
+	Fqbn          string
+	CliPath       *paths.Path
+	CliConfigPath *paths.Path
+	ClangdPath    *paths.Path
+	FormatterConf *paths.Path
+	EnableLogging bool
 }
 
 var yellow = color.New(color.FgHiYellow)
@@ -129,17 +108,13 @@ func (ls *INOLanguageServer) readUnlock(logger jsonrpc.FunctionLogger) {
 }
 
 // NewINOLanguageServer creates and configures an Arduino Language Server.
-func NewINOLanguageServer(stdin io.Reader, stdout io.Writer, board Board) *INOLanguageServer {
+func NewINOLanguageServer(stdin io.Reader, stdout io.Writer, config *Config) *INOLanguageServer {
 	logger := NewLSPFunctionLogger(color.HiWhiteString, "LS: ")
 	ls := &INOLanguageServer{
 		trackedInoDocs:         map[string]lsp.TextDocumentItem{},
 		inoDocsWithDiagnostics: map[lsp.DocumentURI]bool{},
 		closing:                make(chan bool),
-		// buildSketchSymbolsLoad:  make(chan bool, 1),
-		// buildSketchSymbolsCheck: make(chan bool, 1),
-		config: BoardConfig{
-			SelectedBoard: board,
-		},
+		config:                 config,
 	}
 	ls.clangdStarted = sync.NewCond(&ls.dataMux)
 	ls.sketchRebuilder = NewSketchBuilder(ls)
@@ -157,12 +132,10 @@ func NewINOLanguageServer(stdin io.Reader, stdout io.Writer, board Board) *INOLa
 		ls.buildSketchRoot = ls.buildPath.Join("sketch")
 	}
 
-	if enableLogging {
-		logger.Logf("Initial board configuration: %s", board)
-		logger.Logf("Language server build path: %s", ls.buildPath)
-		logger.Logf("Language server build sketch root: %s", ls.buildSketchRoot)
-		logger.Logf("Language server compile-commands: %s", ls.compileCommandsDir.Join("compile_commands.json"))
-	}
+	logger.Logf("Initial board configuration: %s", ls.config.Fqbn)
+	logger.Logf("Language server build path: %s", ls.buildPath)
+	logger.Logf("Language server build sketch root: %s", ls.buildSketchRoot)
+	logger.Logf("Language server compile-commands: %s", ls.compileCommandsDir.Join("compile_commands.json"))
 
 	ls.IDE = NewIDELSPServer(logger, stdin, stdout, ls)
 	ls.progressHandler = NewProgressProxy(ls.IDE.conn)
@@ -210,14 +183,14 @@ func (ls *INOLanguageServer) InitializeReqFromIDE(ctx context.Context, logger js
 		}
 
 		// Retrieve data folder
-		dataFolder, err := extractDataFolderFromArduinoCLI(logger)
+		dataFolder, err := ls.extractDataFolderFromArduinoCLI(logger)
 		if err != nil {
 			logger.Logf("error retrieving data folder from arduino-cli: %s", err)
 			return
 		}
 
 		// Start clangd
-		ls.Clangd = NewClangdLSPClient(logger, ls.buildPath, ls.buildSketchCpp, dataFolder, ls)
+		ls.Clangd = NewClangdLSPClient(logger, dataFolder, ls)
 		go func() {
 			defer streams.CatchAndLogPanic()
 			ls.Clangd.Run()
@@ -1043,10 +1016,10 @@ func (ls *INOLanguageServer) CleanUp() {
 	}
 }
 
-func extractDataFolderFromArduinoCLI(logger jsonrpc.FunctionLogger) (*paths.Path, error) {
+func (ls *INOLanguageServer) extractDataFolderFromArduinoCLI(logger jsonrpc.FunctionLogger) (*paths.Path, error) {
 	// XXX: do this from IDE or via gRPC
-	args := []string{globalCliPath,
-		"--config-file", globalCliConfigPath,
+	args := []string{ls.config.CliPath.String(),
+		"--config-file", ls.config.CliConfigPath.String(),
 		"config",
 		"dump",
 		"--format", "json",
@@ -1806,9 +1779,9 @@ WhitespaceSensitiveMacros: []
 	if sketchFormatterConf := ls.sketchRoot.Join(".clang-format"); sketchFormatterConf.Exist() {
 		// If a custom config is present in the sketch folder, use that one
 		try(sketchFormatterConf)
-	} else if globalFormatterConf != nil && globalFormatterConf.Exist() {
+	} else if ls.config.FormatterConf != nil && ls.config.FormatterConf.Exist() {
 		// Otherwise if a global config file is present, use that one
-		try(globalFormatterConf)
+		try(ls.config.FormatterConf)
 	}
 
 	targetFile := cppuri.AsPath()

ls/lsp_client_clangd.go

@@ -21,18 +21,17 @@ type ClangdLSPClient struct {
 	ls   *INOLanguageServer
 }
 
-func NewClangdLSPClient(logger jsonrpc.FunctionLogger, compileCommandsDir, buildSketchCpp, dataFolder *paths.Path, inoLanguageServer *INOLanguageServer) *ClangdLSPClient {
+func NewClangdLSPClient(logger jsonrpc.FunctionLogger, dataFolder *paths.Path, ls *INOLanguageServer) *ClangdLSPClient {
 	// Start clangd
 	args := []string{
-		globalClangdPath,
+		ls.config.ClangdPath.String(),
 		"-log=verbose",
-		fmt.Sprintf(`--compile-commands-dir=%s`, compileCommandsDir),
+		fmt.Sprintf(`--compile-commands-dir=%s`, ls.buildPath),
 	}
 	if dataFolder != nil {
 		args = append(args, fmt.Sprintf("-query-driver=%s", dataFolder.Join("packages", "**")))
 	}
 
-	//	clangdStdout, clangdStdin, clangdStderr := startClangd(logger, compileCommandsDir, buildSketchCpp, dataFolder)
 	logger.Logf("    Starting clangd: %s", strings.Join(args, " "))
 	var clangdStdin io.WriteCloser
 	var clangdStdout, clangdStderr io.ReadCloser
@@ -53,15 +52,15 @@ func NewClangdLSPClient(logger jsonrpc.FunctionLogger, compileCommandsDir, build
 	}
 
 	clangdStdio := streams.NewReadWriteCloser(clangdStdout, clangdStdin)
-	if enableLogging {
+	if ls.config.EnableLogging {
 		clangdStdio = streams.LogReadWriteCloserAs(clangdStdio, "inols-clangd.log")
 		go io.Copy(streams.OpenLogFileAs("inols-clangd-err.log"), clangdStderr)
 	} else {
 		go io.Copy(os.Stderr, clangdStderr)
 	}
 
 	client := &ClangdLSPClient{
-		ls: inoLanguageServer,
+		ls: ls,
 	}
 	client.conn = lsp.NewClient(clangdStdio, clangdStdio, client)
 	client.conn.SetLogger(&LSPLogger{

ls/unused.go

@@ -21,9 +21,8 @@ func (ls *INOLanguageServer) handleError(logger jsonrpc.FunctionLogger, err erro
 		submatch := exp.FindStringSubmatch(errorStr)
 		message = submatch[1]
 	} else if strings.Contains(errorStr, "platform not installed") || strings.Contains(errorStr, "no FQBN provided") {
-		if len(ls.config.SelectedBoard.Name) > 0 {
-			board := ls.config.SelectedBoard.Name
-			message = "Editor support may be inaccurate because the core for the board `" + board + "` is not installed."
+		if ls.config.Fqbn != "" {
+			message = "Editor support may be inaccurate because the core for the board `" + ls.config.Fqbn + "` is not installed."
 			message += " Use the Boards Manager to install it."
 		} else {
 			// This case happens most often when the app is started for the first time and no

main.go

@@ -56,16 +56,31 @@ func main() {
 	if cliConfigPath == "" {
 		log.Fatal("Path to ArduinoCLI config file must be set.")
 	}
+	if clangdPath == "" {
+		log.Fatal("Path to Clangd must be set.")
+	}
 
-	ls.Setup(cliPath, cliConfigPath, clangdPath, formatFilePath, enableLogging)
-	initialBoard := ls.Board{Fqbn: initialFqbn, Name: initialBoardName}
+	config := &ls.Config{
+		Fqbn:          initialFqbn,
+		ClangdPath:    paths.New(clangdPath),
+		EnableLogging: enableLogging,
+	}
+	if cliPath != "" {
+		config.CliPath = paths.New(cliPath)
+	}
+	if cliConfigPath != "" {
+		config.CliConfigPath = paths.New(cliConfigPath)
+	}
+	if formatFilePath != "" {
+		config.FormatterConf = paths.New(formatFilePath)
+	}
 
 	stdio := streams.NewReadWriteCloser(os.Stdin, os.Stdout)
 	if enableLogging {
 		stdio = streams.LogReadWriteCloserAs(stdio, "inols.log")
 	}
 
-	inoHandler := ls.NewINOLanguageServer(stdio, stdio, initialBoard)
+	inoHandler := ls.NewINOLanguageServer(stdio, stdio, config)
 
 	// Intercept kill signal
 	c := make(chan os.Signal, 2)