*** empty log message ***
[bpt/emacs.git] / lisp / progmodes / prolog.el
index d23dbad..53a010a 100644 (file)
@@ -1,17 +1,17 @@
 ;;; prolog.el --- major mode for editing and running Prolog under Emacs
 
-;; Copyright (C) 1986, 1987, 2001, 2002, 2003, 2004, 2005
-;; Free Software Foundation, Inc.
+;; Copyright (C) 1986, 1987, 2001, 2002, 2003, 2004, 2005, 2006, 2007,
+;;   2008, 2009  Free Software Foundation, Inc.
 
 ;; Author: Masanobu UMEDA <umerin@mse.kyutech.ac.jp>
 ;; Keywords: languages
 
 ;; This file is part of GNU Emacs.
 
-;; GNU Emacs is free software; you can redistribute it and/or modify
+;; GNU Emacs 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 2, or (at your option)
-;; any later version.
+;; the Free Software Foundation, either version 3 of the License, or
+;; (at your option) any later version.
 
 ;; GNU Emacs is distributed in the hope that it will be useful,
 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
@@ -19,9 +19,7 @@
 ;; GNU General Public License for more details.
 
 ;; You should have received a copy of the GNU General Public License
-;; along with GNU Emacs; see the file COPYING.  If not, write to the
-;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
-;; Boston, MA 02110-1301, USA.
+;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
 
 ;;; Commentary:
 
 ;;; Code:
 
 (defvar comint-prompt-regexp)
-
+(defvar comint-process-echoes)
 
 (defgroup prolog nil
   "Major mode for editing and running Prolog under Emacs."
+  :link '(custom-group-link :tag "Font Lock Faces group" font-lock-faces)
   :group 'languages)
 
 
 (defcustom prolog-program-name
-  (let ((names '("prolog" "gprolog")))
+  (let ((names '("prolog" "gprolog" "swipl")))
     (while (and names
                (not (executable-find (car names))))
       (setq names (cdr names)))
     (or (car names) "prolog"))
-  "*Program name for invoking an inferior Prolog with `run-prolog'."
+  "Program name for invoking an inferior Prolog with `run-prolog'."
   :type 'string
   :group 'prolog)
 
 (defcustom prolog-consult-string "reconsult(user).\n"
-  "*(Re)Consult mode (for C-Prolog and Quintus Prolog). "
+  "(Re)Consult mode (for C-Prolog and Quintus Prolog). "
   :type 'string
   :group 'prolog)
 
 (defcustom prolog-compile-string "compile(user).\n"
-  "*Compile mode (for Quintus Prolog)."
+  "Compile mode (for Quintus Prolog)."
   :type 'string
   :group 'prolog)
 
 (defcustom prolog-eof-string "end_of_file.\n"
-  "*String that represents end of file for Prolog.
+  "String that represents end of file for Prolog.
 When nil, send actual operating system end of file."
   :type 'string
   :group 'prolog)
@@ -120,7 +119,21 @@ When nil, send actual operating system end of file."
 (defvar prolog-mode-map
   (let ((map (make-sparse-keymap)))
     (define-key map "\e\C-x" 'prolog-consult-region)
+    (define-key map "\C-c\C-l" 'inferior-prolog-load-file)
+    (define-key map "\C-c\C-z" 'switch-to-prolog)
     map))
+(easy-menu-define prolog-mode-menu prolog-mode-map "Menu for Prolog mode."
+  ;; Mostly copied from scheme-mode's menu.
+  ;; Not tremendously useful, but it's a start.
+  '("Prolog"
+    ["Indent line" indent-according-to-mode t]
+    ["Indent region" indent-region t]
+    ["Comment region" comment-region t]
+    ["Uncomment region" uncomment-region t]
+    "--"
+    ["Run interactive Prolog session" run-prolog t]
+    ))
 
 ;;;###autoload
 (defun prolog-mode ()
@@ -137,29 +150,24 @@ if that value is non-nil."
   (setq major-mode 'prolog-mode)
   (setq mode-name "Prolog")
   (prolog-mode-variables)
+  (set (make-local-variable 'comment-add) 1)
   ;; font lock
   (setq font-lock-defaults '(prolog-font-lock-keywords
                              nil nil nil
                              beginning-of-line))
   (run-mode-hooks 'prolog-mode-hook))
 
-(defun prolog-indent-line (&optional whole-exp)
+(defun prolog-indent-line ()
   "Indent current line as Prolog code.
 With argument, indent any additional lines of the same clause
 rigidly along with this one (not yet)."
   (interactive "p")
   (let ((indent (prolog-indent-level))
-       (pos (- (point-max) (point))) beg)
+       (pos (- (point-max) (point))))
     (beginning-of-line)
-    (setq beg (point))
-    (skip-chars-forward " \t")
-    (if (zerop (- indent (current-column)))
-       nil
-      (delete-region beg (point))
-      (indent-to indent))
+    (indent-line-to indent)
     (if (> (- (point-max) pos) (point))
-       (goto-char (- (point-max) pos)))
-    ))
+       (goto-char (- (point-max) pos)))))
 
 (defun prolog-indent-level ()
   "Compute Prolog indentation level."
@@ -223,11 +231,24 @@ rigidly along with this one (not yet)."
   (let ((map (make-sparse-keymap)))
     ;; This map will inherit from `comint-mode-map' when entering
     ;; inferior-prolog-mode.
+    (define-key map [remap self-insert-command]
+      'inferior-prolog-self-insert-command)
     map))
 
 (defvar inferior-prolog-mode-syntax-table prolog-mode-syntax-table)
 (defvar inferior-prolog-mode-abbrev-table prolog-mode-abbrev-table)
 
+(defvar inferior-prolog-error-regexp-alist
+  ;; GNU Prolog used to not follow the GNU standard format.
+  '(("^\\(.*?\\):\\([0-9]+\\) error: .*(char:\\([0-9]+\\)" 1 2 3)
+    gnu))
+
+(declare-function comint-mode "comint")
+(declare-function comint-send-string "comint" (process string))
+(declare-function comint-send-region "comint" (process start end))
+(declare-function comint-send-eof "comint" ())
+(defvar compilation-error-regexp-alist)
+
 (define-derived-mode inferior-prolog-mode comint-mode "Inferior Prolog"
   "Major mode for interacting with an inferior Prolog process.
 
@@ -253,38 +274,142 @@ Return not at end copies rest of line to end and sends it.
 \\[comint-interrupt-subjob] interrupts the shell or its current subjob if any.
 \\[comint-stop-subjob] stops. \\[comint-quit-subjob] sends quit signal."
   (setq comint-prompt-regexp "^| [ ?][- ] *")
+  (set (make-local-variable 'compilation-error-regexp-alist)
+       inferior-prolog-error-regexp-alist)
+  (compilation-shell-minor-mode)
   (prolog-mode-variables))
 
+(defvar inferior-prolog-buffer nil)
+
+(defvar inferior-prolog-flavor 'unknown
+  "Either a symbol or a buffer position offset by one.
+If a buffer position, the flavor has not been determined yet and
+it is expected that the process's output has been or will
+be inserted at that position plus one.")
+
+(defun inferior-prolog-run (&optional name)
+  (with-current-buffer (make-comint "prolog" (or name prolog-program-name))
+    (inferior-prolog-mode)
+    (setq-default inferior-prolog-buffer (current-buffer))
+    (make-local-variable 'inferior-prolog-buffer)
+    (when (and name (not (equal name prolog-program-name)))
+      (set (make-local-variable 'prolog-program-name) name))
+    (set (make-local-variable 'inferior-prolog-flavor)
+         ;; Force re-detection.
+         (let* ((proc (get-buffer-process (current-buffer)))
+                (pmark (and proc (marker-position (process-mark proc)))))
+           (cond
+            ((null pmark) (1- (point-min)))
+            ;; The use of insert-before-markers in comint.el together with
+            ;; the potential use of comint-truncate-buffer in the output
+            ;; filter, means that it's difficult to reliably keep track of
+            ;; the buffer position where the process's output started.
+            ;; If possible we use a marker at "start - 1", so that
+            ;; insert-before-marker at `start' won't shift it.  And if not,
+            ;; we fall back on using a plain integer.
+            ((> pmark (point-min)) (copy-marker (1- pmark)))
+            (t (1- pmark)))))
+    (add-hook 'comint-output-filter-functions
+              'inferior-prolog-guess-flavor nil t)))
+
+(defun inferior-prolog-process (&optional dontstart)
+  (or (and (buffer-live-p inferior-prolog-buffer)
+           (get-buffer-process inferior-prolog-buffer))
+      (unless dontstart
+        (inferior-prolog-run)
+        ;; Try again.
+        (inferior-prolog-process))))
+
+(defun inferior-prolog-guess-flavor (&optional ignored)
+  (save-excursion
+    (goto-char (1+ inferior-prolog-flavor))
+    (setq inferior-prolog-flavor
+          (cond
+           ((looking-at "GNU Prolog") 'gnu)
+           ((looking-at "Welcome to SWI-Prolog") 'swi)
+           ((looking-at ".*\n") 'unknown) ;There's at least one line.
+           (t inferior-prolog-flavor))))
+  (when (symbolp inferior-prolog-flavor)
+    (remove-hook 'comint-output-filter-functions
+                 'inferior-prolog-guess-flavor t)
+    (if (eq inferior-prolog-flavor 'gnu)
+        (set (make-local-variable 'comint-process-echoes) t))))
+
+;;;###autoload
+(defalias 'run-prolog 'switch-to-prolog)
 ;;;###autoload
-(defun run-prolog ()
-  "Run an inferior Prolog process, input and output via buffer *prolog*."
+(defun switch-to-prolog (&optional name)
+  "Run an inferior Prolog process, input and output via buffer *prolog*.
+With prefix argument \\[universal-prefix], prompt for the program to use."
+  (interactive
+   (list (when current-prefix-arg
+           (let ((proc (inferior-prolog-process 'dontstart)))
+             (if proc
+                 (if (yes-or-no-p "Kill current process before starting new one? ")
+                     (kill-process proc)
+                   (error "Abort")))
+             (read-string "Run Prolog: " prolog-program-name)))))
+  (unless (inferior-prolog-process 'dontstart)
+    (inferior-prolog-run name))
+  (pop-to-buffer inferior-prolog-buffer))
+
+(defun inferior-prolog-self-insert-command ()
+  "Insert the char in the buffer or pass it directly to the process."
   (interactive)
-  (require 'comint)
-  (pop-to-buffer (make-comint "prolog" prolog-program-name))
-  (inferior-prolog-mode))
+  (let* ((proc (get-buffer-process (current-buffer)))
+         (pmark (and proc (marker-position (process-mark proc)))))
+    (if (and (eq inferior-prolog-flavor 'gnu)
+             pmark
+             (null current-prefix-arg)
+             (eobp)
+             (eq (point) pmark)
+             (save-excursion
+               (goto-char (- pmark 3))
+               (looking-at " \\? ")))
+        ;; This is GNU prolog waiting to know whether you want more answers
+        ;; or not (or abort, etc...).  The answer is a single char, not
+        ;; a line, so pass this char directly rather than wait for RET to
+        ;; send a whole line.
+        (comint-send-string proc (string last-command-event))
+      (call-interactively 'self-insert-command))))
 
 (defun prolog-consult-region (compile beg end)
   "Send the region to the Prolog process made by \"M-x run-prolog\".
 If COMPILE (prefix arg) is not nil, use compile mode rather than consult mode."
   (interactive "P\nr")
-  (save-excursion
-    (if compile
-       (process-send-string "prolog" prolog-compile-string)
-      (process-send-string "prolog" prolog-consult-string))
-    (process-send-region "prolog" beg end)
-    (process-send-string "prolog" "\n")                ;May be unnecessary
+  (let ((proc (inferior-prolog-process)))
+    (comint-send-string proc
+                        (if compile prolog-compile-string
+                          prolog-consult-string))
+    (comint-send-region proc beg end)
+    (comint-send-string proc "\n")             ;May be unnecessary
     (if prolog-eof-string
-       (process-send-string "prolog" prolog-eof-string)
-      (process-send-eof "prolog")))) ;Send eof to prolog process.
+        (comint-send-string proc prolog-eof-string)
+      (with-current-buffer (process-buffer proc)
+        (comint-send-eof))))) ;Send eof to prolog process.
 
 (defun prolog-consult-region-and-go (compile beg end)
   "Send the region to the inferior Prolog, and switch to *prolog* buffer.
 If COMPILE (prefix arg) is not nil, use compile mode rather than consult mode."
   (interactive "P\nr")
   (prolog-consult-region compile beg end)
-  (switch-to-buffer "*prolog*"))
+  (pop-to-buffer inferior-prolog-buffer))
+
+;; inferior-prolog-mode uses the autoloaded compilation-shell-minor-mode.
+(declare-function compilation-forget-errors "compile" ())
+
+(defun inferior-prolog-load-file ()
+  "Pass the current buffer's file to the inferior prolog process."
+  (interactive)
+  (save-buffer)
+  (let ((file buffer-file-name)
+        (proc (inferior-prolog-process)))
+    (with-current-buffer (process-buffer proc)
+      (compilation-forget-errors)
+      (comint-send-string proc (concat "['" (file-relative-name file) "'].\n"))
+      (pop-to-buffer (current-buffer)))))
 
 (provide 'prolog)
 
-;;; arch-tag: f3ec6748-1272-4ab6-8826-c50cb1607636
+;; arch-tag: f3ec6748-1272-4ab6-8826-c50cb1607636
 ;;; prolog.el ends here