Add support for SWI-Prolog (#514)

* Add support for SWI-Prolog

* Update docs/page/configuration.md

Co-authored-by: Randy Taylor <[email protected]>

Co-authored-by: Ivan Yonchovski <[email protected]>
Co-authored-by: Randy Taylor <[email protected]>

Author: 3 people

Makefile

@@ -12,7 +12,7 @@ DAP-CLIENTS := dap-chrome.el dap-cpptools.el dap-edge.el		\
 		dap-elixir.el dap-firefox.el dap-gdb-lldb.el		\
 		dap-go.el dap-lldb.el dap-netcore.el dap-node.el	\
 		dap-php.el dap-pwsh.el dap-python.el dap-ruby.el	\
-		dap-codelldb.el dap-erlang.el
+		dap-codelldb.el dap-erlang.el dap-swi-prolog.el
 
 TEST-FILES := test/windows-bootstrap.el $(shell ls test/dap-*.el)
 LOAD-FILE = -l $(test-file)

dap-swi-prolog.el

@@ -0,0 +1,57 @@
+;;; dap-swi-prolog.el --- Debug Adapter Protocol mode for SWI-Prolog      -*- lexical-binding: t; -*-
+
+;; Copyright (C) 2021 Eshel Yaron
+
+;; Author: Eshel Yaron <[email protected]>
+;; Keywords: languages
+
+;; This program is free software; you can redistribute it and/or modify
+;; it under the terms of the GNU General Public License as published by
+;; the Free Software Foundation, either version 3 of the License, or
+;; (at your option) any later version.
+
+;; This program is distributed in the hope that it will be useful,
+;; but WITHOUT ANY WARRANTY; without even the implied warranty of
+;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+;; GNU General Public License for more details.
+
+;; You should have received a copy of the GNU General Public License
+;; along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+;; URL: https://github.com/yyoncho/dap-mode
+;; Package-Requires: ((emacs "25.1") (dash "2.14.1") (lsp-mode "4.0"))
+;; Version: 0.2
+
+;;; Commentary:
+;; Adapter for https://www.swi-prolog.org
+
+;;; Code:
+
+(require 'dap-mode)
+
+(defcustom dap-swi-prolog-debug-program
+    `(,(locate-file "swipl_debug_adapter" exec-path))
+  "The path to the SWI-Prolog debug adapter."
+  :group 'dap-swi-prolog
+  :type '(repeat string))
+
+(defun dap-swi-prolog--populate-start-file-args (conf)
+  "Populate CONF with the required arguments."
+  (let ((conf (-> conf
+                  (dap--put-if-absent :dap-server-path dap-swi-prolog-debug-program)
+                  (dap--put-if-absent :type "swi-prolog")
+                  (dap--put-if-absent :cwd default-directory)
+                  (dap--put-if-absent :module (buffer-file-name))
+                  (dap--put-if-absent :goal (read-string "Goal: " nil nil "true"))
+                  (dap--put-if-absent :name "SWI-Prolog Debug"))))
+    conf))
+
+(dap-register-debug-provider "swi-prolog" #'dap-swi-prolog--populate-start-file-args)
+
+(dap-register-debug-template "SWI-Prolog Run Configuration"
+                             (list :type "swi-prolog"
+                                   :request "launch"
+                                   :name "SWI-Prolog::Run"))
+
+(provide 'dap-swi-prolog)
+;;; dap-swi-prolog.el ends here

docs/page/configuration.md

@@ -233,6 +233,19 @@ Start debugging by selecting "PHP Run Configuration" from the
 `dap-debug` menu, issue the debug request in your browser by choosing
 the running thread (`dap-switch-thread`) and then `dap-step-in`.
 
+## SWI-Prolog
+
+1. With SWI-Prolog [installed](https://www.swi-prolog.org/Download.html),
+   run the following command to build and install the debug adapter executable `swipl_debug_adapter`:
+   ```shell
+   swipl -g "pack_install(debug_adapter)" -t halt
+   ```
+2. Add the following line to your Emacs setup:
+   ``` elisp
+   (require 'dap-swi-prolog)
+   ```
+3. Run `dap-debug` in a Prolog buffer and start debugging.
+
 ## Native Debug (GDB/LLDB)
 
 Using <https://github.com/WebFreak001/code-debug>

docs/page/gallery.md

@@ -28,3 +28,7 @@ Gallery
 ## Erlang
 
 ![Erlang via Erlang LS](../screenshots/erlang.png)
+
+## SWI-Prolog
+
+![SWI-Prolog](../screenshots/swi-prolog.png)