[mlir] Add the Emacs support for MLIR's LSP server

[lxsameer]

Summary

In order to use the MLIR LSP server in Emacs, first the mlir-lsp-client.el
has to be loaded via elisp and then, one should call lsp-mlir-setup function
to setup the LSP client. After that simply calling the lsp function while
the mlir-mode is active with result in finding the language server (default
to mlir-lsp-server) via the lsp-mlir-server-executable customization variable
and connecting to it by the LSP library. Users who use MLIR's language server
library to create their own server can simply set the variable lsp-mlir-server-executable
to point to their own implementation executable.

[tschuett]

mlir/utils/emacs/mlir-lsp-client.el

20

[lxsameer]

Fixed a typo

[tschuett]

Do you want to eventually upstream the support for MLIR to https://github.com/emacs-lsp/lsp-mode/?

[lxsameer]

I've thought about it, but I had two pros for keeping it here in my head: 1) since the mlir-mode and the mlir-lsp-server are distributed with LLVM, maybe it is better to keep it here (for example to match the compatibility) 2) it might worth merging this client with the mlir-mode

wdyt?

[tschuett]

In D123002#3425422, @lxsameer wrote:

I've thought about it, but I had two pros for keeping it here in my head: 1) since the mlir-mode and the mlir-lsp-server are distributed with LLVM, maybe it is better to keep it here (for example to match the compatibility) 2) it might worth merging this client with the mlir-mode

wdyt?

Totally up to you, but lsp-mode ships lsp-clients for many servers that are distributed over different channels. I use at least clangd and rust-analyzer.

[lxsameer]

Added the missing custom group

[lxsameer]

In D123002#3425431, @tschuett wrote:

In D123002#3425422, @lxsameer wrote:

I've thought about it, but I had two pros for keeping it here in my head: 1) since the mlir-mode and the mlir-lsp-server are distributed with LLVM, maybe it is better to keep it here (for example to match the compatibility) 2) it might worth merging this client with the mlir-mode

wdyt?

Totally up to you, but lsp-mode ships lsp-clients for many servers that are distributed over different channels. I use at least clangd and rust-analyzer.

So I think, let's keep it here for a while. I'm going to work more on it. and also I'll probably add support for eglot as well

[lxsameer]

@tschuett may I get your approval please?

[tschuett]

LGTM

[keryell]

mlir/utils/emacs/mlir-lsp-client.el

20

It looks like this change did not get through.

[lxsameer]

What do you mean? The whole commit or that one line ?

[tschuett]

In D123002#4253125, @lxsameer wrote:

What do you mean? The whole commit or that one line ?

The typo.

mlir/utils/emacs/mlir-lsp-client.el

+;;; mlir-lsp-clinet.el --- LSP clinet for the MLIR.
+
+;; Copyright (C) 2022 The MLIR Authors.
+;;
+;; Licensed under the Apache License, Version 2.0 (the "License");
+;; you may not use this file except in compliance with the License.
+;; You may obtain a copy of the License at
+;;
+;;      http://www.apache.org/licenses/LICENSE-2.0
+;;
+;; Unless required by applicable law or agreed to in writing, software
+;; distributed under the License is distributed on an "AS IS" BASIS,
+;; WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+;; See the License for the specific language governing permissions and
+;; limitations under the License.
+
+;;; Commentary:
+
+;; LSP clinet to use with `mlir-mode' that uses `mlir-lsp-server' or any
+;; user made compatible server.
+
+;;; Code:
+(require 'lsp-mod)
+
+(defgroup lsp-mlir nil
+  "LSP support for MLIR."
+  :group 'lsp-mode
+  :link '(url-link "https://mlir.llvm.org/docs/Tools/MLIRLSP/"))
+
+
+(defcustom lsp-mlir-server-executable "mlir-lsp-server"
+  "Command to start the mlir language server."
+  :group 'lsp-mlir
+  :risky t
+  :type 'file)
+
+
+(defun lsp-mlir-setup ()
+  "Setup the LSP client for MLIR."
+  (add-to-list 'lsp-language-id-configuration '(mlir-mode . "mlir"))
+
+  (lsp-register-client
+   (make-lsp-client
+    :new-connection (lsp-stdio-connection (lambda () lsp-mlir-server-executable))
+    :activation-fn (lsp-activate-on "mlir")
+    :priority -1
+    :server-id 'mlir-lsp)))
+
+
+(provide 'mlir-lsp-client)
+;;; mlir-lsp-client.el ends here