Skip to content

Commit

Permalink
Add missing configuration options for the Ada Language Server. (#4567)
Browse files Browse the repository at this point in the history
  • Loading branch information
@brownts
brownts authored Dec 14, 2024
1 parent c3be413 commit 7d8f232
Showing 1 changed file with 224 additions and 24 deletions.
248 changes: 224 additions & 24 deletions clients/lsp-ada.el
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,20 @@
(require 'lsp-semantic-tokens)

(defgroup lsp-ada nil
"Settings for Ada Language Server."
:group 'tools
:tag "Language Server"
"Settings for Ada Language Server.
There is a hierarchy of configuration sources which are considered by
the Ada Language Server, including `lsp-mode' configuration settings,
external configuration files, as well as the server's own default
settings. When `lsp-mode' does not explicitly provide a value for a
setting (i.e., it is \\='Not Specified\\='), its value will be
determined by one of the other configuration sources. Refer to the Ada
Language Server's Settings Documentation for specific details."
:group 'lsp-mode
:link `(url-link :tag "Settings Documentation"
,(concat "https://github.com/AdaCore/ada_language_server"
"/blob/master/doc/settings.md"))
:prefix "lsp-ada-"
:package-version '(lsp-mode . "6.2"))

(lsp-defcustom lsp-ada-project-file nil
Expand All @@ -57,25 +68,198 @@ environment."
;;;###autoload(put 'lsp-ada-project-file 'safe-local-variable 'stringp)

(lsp-defcustom lsp-ada-option-charset "UTF-8"
"The charset to use by the Ada Language server. Defaults to \\='UTF-8\\='."
:type 'string
"The charset to use by the Ada Language server. Defaults to \\='UTF-8\\='."
:type '(choice (string :tag "Charset")
(const :tag "Not Specified" nil))
:group 'lsp-ada
:package-version '(lsp-mode . "6.2")
:lsp-path "ada.defaultCharset")

(lsp-defcustom lsp-ada-enable-diagnostics t
"A boolean to disable diagnostics. Defaults to true."
:type 'boolean
(lsp-defcustom lsp-ada-display-method-ancestry-on-navigation nil
"Policy for displaying overriding/overridden subprograms on navigation requests."
:type '(choice (const "never")
(const "usage_and_abstract_only")
(const "definition_only")
(const "always")
(const :tag "Not Specified" nil))
:group 'lsp-ada
:package-version '(lsp-mode . "6.2")
:package-version '(lsp-mode . "9.0.1")
:lsp-path "ada.displayMethodAncestryOnNavigation")

(lsp-defcustom lsp-ada-documentation-style nil
"Style used to extract documentation for an entity."
:type '(choice (const "gnat")
(const "leading")
(const :tag "Not Specified" nil))
:group 'lsp-ada
:package-version '(lsp-mode . "9.0.1")
:lsp-path "ada.documentationStyle")

(lsp-defcustom lsp-ada-enable-diagnostics nil
"Whether diagnostics are enabled."
:type '(choice (const :tag "Enabled" t)
(const :tag "Disabled" :json-false)
(const :tag "Not Specified" nil))
:group 'lsp-ada
:package-version '(lsp-mode . "9.0.1")
:lsp-path "ada.enableDiagnostics")

(lsp-defcustom lsp-ada-enable-indexing nil
"Whether the server indexes the source files after loading a project."
:type '(choice (const :tag "Enabled" t)
(const :tag "Disabled" :json-false)
(const :tag "Not Specified" nil))
:group 'lsp-ada
:package-version '(lsp-mode . "9.0.1")
:lsp-path "ada.enableIndexing")

(lsp-defcustom lsp-ada-fold-comments nil
"Whether the server sends information to control folding comment blocks."
:type '(choice (const :tag "Enabled" t)
(const :tag "Disabled" :json-false)
(const :tag "Not Specified" nil))
:group 'lsp-ada
:package-version '(lsp-mode . "9.0.1")
:lsp-path "ada.foldComments")

(lsp-defcustom lsp-ada-follow-symlinks nil
"Whether the server attempts to resolve symlinks for file names."
:type '(choice (const :tag "Enabled" t)
(const :tag "Disabled" :json-false)
(const :tag "Not Specified" nil))
:group 'lsp-ada
:package-version '(lsp-mode . "9.0.1")
:lsp-path "ada.followSymlinks")

(lsp-defcustom lsp-ada-insert-with-clauses nil
"Whether to automatically insert missing with-clauses for completions."
:type '(choice (const :tag "Enabled" t)
(const :tag "Disabled" :json-false)
(const :tag "Not Specified" nil))
:group 'lsp-ada
:package-version '(lsp-mode . "9.0.1")
:lsp-path "ada.insertWithClauses")

(lsp-defcustom lsp-ada-log-threshold nil
"Maximum number of preserved trace files in the ALS log directory."
:type '(choice (integer :tag "Threshold")
(const :tag "Not Specified" nil))
:group 'lsp-ada
:link `(url-link :tag "Traces Documentation"
,(concat "https://github.com/AdaCore/ada_language_server"
"/blob/master/doc/traces.md"))
:package-version '(lsp-mode . "9.0.1")
:lsp-path "ada.logThreshold")

(lsp-defcustom lsp-ada-named-notation-threshold nil
"Number of parameters when named notation is used in completion snippets."
:type '(choice (integer :tag "Threshold")
(const :tag "Not Specified" nil))
:group 'lsp-ada
:package-version '(lsp-mode . "9.0.1")
:lsp-path "ada.namedNotationThreshold")

(lsp-defcustom lsp-ada-on-type-formatting-indent-only nil
"Whether textDocument/onTypeFormatting request only indents a new line."
:type '(choice (const :tag "Enabled" t)
(const :tag "Disabled" :json-false)
(const :tag "Not Specified" nil))
:group 'lsp-ada
:package-version '(lsp-mode . "9.0.1")
:lsp-path "ada.onTypeFormatting.indentOnly")

(lsp-defcustom lsp-ada-project-diagnostics nil
"Whether the Ada Language Server should emit project diagnostics.
This setting is ignored if `lsp-ada-enable-diagnostics' is not enabled.
A workspace reload is necessary to refresh the diagnostics after
modifying this setting."
:type '(choice (const :tag "Enabled" t)
(const :tag "Disabled" :json-false)
(const :tag "Not Specified" nil))
:group 'lsp-ada
:package-version '(lsp-mode . "9.0.1")
:lsp-path "ada.projectDiagnostics")

(lsp-defcustom lsp-ada-relocate-build-tree nil
"Path to use for out-of-tree builds."
:type '(choice (string :tag "Path")
(const :tag "Not Specified" nil))
:group 'lsp-ada
:package-version '(lsp-mode . "9.0.1")
:lsp-path "ada.relocateBuildTree")

(lsp-defcustom lsp-ada-root-dir nil
"The root directory for artifact relocation.
This setting must be used in conjunction with `lsp-ada-relocate-build-tree'."
:type '(choice (string :tag "Root Dir")
(const :tag "Not Specified" nil))
:group 'lsp-ada
:package-version '(lsp-mode . "9.0.1")
:lsp-path "ada.rootDir")

(lsp-defcustom lsp-ada-rename-in-comments nil
"Whether to apply textDocument/rename to comments."
:type '(choice (const :tag "Enabled" t)
(const :tag "Disabled" :json-false)
(const :tag "Not Specified" nil))
:group 'lsp-ada
:package-version '(lsp-mode . "9.0.1")
:lsp-path "ada.renameInComments")

(lsp-defcustom lsp-ada-scenario-variables nil
"Scenario variables for project."
:type '(alist :tag "Scenario Variable(s)"
:key-type (symbol :tag "Variable Name")
:value-type (string :tag "Value"))
:group 'lsp-ada
:package-version '(lsp-mode . "9.0.1")
:lsp-path "ada.scenarioVariables")

(lsp-defcustom lsp-ada-use-completion-snippets nil
"Whether to enable snippets in completion results."
:type '(choice (const :tag "Enabled" t)
(const :tag "Disabled" :json-false)
(const :tag "Not Specified" nil))
:group 'lsp-ada
:package-version '(lsp-mode . "9.0.1")
:lsp-path "ada.useCompletionSnippets")

(lsp-defcustom lsp-ada-use-gnatformat nil
"Enables GNATformat as the formatting provider for Ada source files.
This option controls the formatting provider."
:type '(choice (const :tag "GNATformat" t)
(const :tag "GNATpp" :json-false)
(const :tag "Not Specified" nil))
:group 'lsp-ada
:package-version '(lsp-mode . "9.0.1")
:lsp-path "ada.useGnatformat")

(defcustom lsp-ada-als-executable "ada_language_server"
"Command to start the Ada language server."
:group 'lsp-ada
:risky t
:type 'file)

(defcustom lsp-ada-library-folders #'lsp-ada--default-library-folders
"List of Ada library folders.
Library folders contain source which may be visited from a workspace,
but whose source files are not themselves considered a separate
workspace. This typically applies to language run-time source file
folders.
Instead of a list of a folders, a function may be provided, which will
be called with the most recently active workspace as a parameter and
must return a list of Ada library folders, or nil if none."
:group 'lsp-ada
:type '(choice function
(repeat :tag "Library Folders"
(directory :tag "Library Folder")))
:package-version '(lsp-mode . "9.0.1"))

(defcustom lsp-ada-semantic-token-face-overrides
'(("namespace" . default)
("modifier" . lsp-face-semhl-keyword))
Expand Down Expand Up @@ -106,6 +290,7 @@ environment."
(defvar lsp-ada--als-downloaded-executable
(f-join lsp-server-install-dir
"ada-ls"
"integration" "vscode" "ada"
(symbol-name (lsp-resolve-value lsp--system-arch))
(pcase system-type
('gnu/linux "linux")
Expand All @@ -122,28 +307,36 @@ environment."
(setq lsp-ada--als-download-url-cache
(lsp--find-latest-gh-release-url
"https://api.github.com/repos/AdaCore/ada_language_server/releases/latest"
(format "%s.zip"
(format "%s.tar.gz"
(pcase (list system-type (lsp-resolve-value lsp--system-arch))
('(gnu/linux x64) "Linux_amd64")
('(gnu/linux arm64) "Linux_aarch64")
('(darwin x64) "macOS_amd64")
('(darwin arm64) "macOS_aarch64")
('(windows-nt x64) "Windows_amd64")
(`(,_ x64) "Linux_amd64"))))))
('(gnu/linux x64) "linux-x64")
('(gnu/linux arm64) "linux-arm64")
('(darwin x64) "darwin-x64")
('(darwin arm64) "darwin-arm64")
('(windows-nt x64) "win32-x64")
(`(,_ x64) "linux-x64"))))))

(defun lsp-ada--als-store-path ()
"Store Path for the downloaded Ada Language Server."
(f-join lsp-server-install-dir
"ada-ls"
(file-name-base (or lsp-ada--als-download-url-cache
(lsp-ada--als-latest-release-url)
"ada-ls"))))
(string-remove-suffix
".tar.gz"
(file-name-nondirectory
(or lsp-ada--als-download-url-cache
(lsp-ada--als-latest-release-url)
"ada-ls")))))

(defun lsp-ada--default-library-folders (_workspace)
"Determine the set of Ada library folders."
(when (string-match-p "/adainclude/" (buffer-file-name))
(list (file-name-directory (buffer-file-name)))))

(lsp-dependency
'ada-ls
'(:download :url lsp-ada--als-latest-release-url
:store-path lsp-ada--als-store-path
:decompress :zip
:decompress :targz
:binary-path lsp-ada--als-downloaded-executable
:set-executable? t)
'(:system lsp-ada-als-executable))
Expand All @@ -153,16 +346,23 @@ environment."
(lambda () (lsp-package-path 'ada-ls)))
:major-modes '(ada-mode ada-ts-mode)
:priority -1
:initialization-options (lambda ()
(ht-get (lsp-configuration-section "ada") "ada"))
;; Send workspace/didChangeConfiguration as a workaround for:
;; https://github.com/AdaCore/ada_language_server/issues/1209
:initialized-fn (lambda (workspace)
(with-lsp-workspace workspace
(lsp--set-configuration
(lsp-configuration-section "ada"))))
(lsp--set-configuration
(lsp-configuration-section "ada"))))
:library-folders-fn (lambda (workspace)
(if (functionp lsp-ada-library-folders)
(funcall lsp-ada-library-folders workspace)
lsp-ada-library-folders))
:download-server-fn (lambda (_client callback error-callback _update?)
(lsp-package-ensure 'ada-ls callback error-callback))
:semantic-tokens-faces-overrides `( :types ,lsp-ada-semantic-token-face-overrides
:modifiers ,lsp-ada-semantic-token-modifier-face-overrides)
:server-id 'ada-ls
:synchronize-sections '("ada")))
:server-id 'ada-ls))

(lsp-register-client
(make-lsp-client :new-connection (lsp-stdio-connection
Expand Down

0 comments on commit 7d8f232

Please sign in to comment.