1 ;;; prolog.el --- major mode for editing and running Prolog under Emacs
3 ;; Copyright (C) 1986, 1987 Free Software Foundation, Inc.
5 ;; Author: Masanobu UMEDA <umerin@mse.kyutech.ac.jp>
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software; you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation; either version 2, or (at your option)
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs; see the file COPYING. If not, write to the
22 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
23 ;; Boston, MA 02111-1307, USA.
27 ;; This package provides a major mode for editing Prolog. It knows
28 ;; about Prolog syntax and comments, and can send regions to an inferior
29 ;; Prolog interpreter process. Font locking is tuned towards GNU Prolog.
33 (defvar prolog-mode-syntax-table nil)
34 (defvar prolog-mode-abbrev-table nil)
35 (defvar prolog-mode-map nil)
38 "Major mode for editing and running Prolog under Emacs"
42 (defcustom prolog-program-name "prolog"
43 "*Program name for invoking an inferior Prolog with `run-prolog'."
47 (defcustom prolog-consult-string "reconsult(user).\n"
48 "*(Re)Consult mode (for C-Prolog and Quintus Prolog). "
52 (defcustom prolog-compile-string "compile(user).\n"
53 "*Compile mode (for Quintus Prolog)."
57 (defcustom prolog-eof-string "end_of_file.\n"
58 "*String that represents end of file for prolog.
59 nil means send actual operating system end of file."
63 (defcustom prolog-indent-width 4
64 "Level of indentation in Prolog buffers."
68 (defvar prolog-font-lock-keywords
69 '(("\\(#[<=]=>\\|:-\\)\\|\\(#=\\)\\|\\(#[#<>\\/][=\\/]*\\|!\\)"
70 0 font-lock-keyword-face)
71 ("\\<\\(is\\|write\\|nl\\|read_\\sw+\\)\\>"
72 1 font-lock-keyword-face)
73 ("^\\(\\sw+\\)\\s-*\\((\\(.+\\))\\)*"
74 (1 font-lock-function-name-face)
75 (3 font-lock-variable-name-face)))
76 "Font-lock keywords for Prolog mode.")
78 (if prolog-mode-syntax-table
80 (let ((table (make-syntax-table)))
81 (modify-syntax-entry ?_ "w" table)
82 (modify-syntax-entry ?\\ "\\" table)
83 (modify-syntax-entry ?/ ". 14" table)
84 (modify-syntax-entry ?* ". 23" table)
85 (modify-syntax-entry ?+ "." table)
86 (modify-syntax-entry ?- "." table)
87 (modify-syntax-entry ?= "." table)
88 (modify-syntax-entry ?% "<" table)
89 (modify-syntax-entry ?\n ">" table)
90 (modify-syntax-entry ?< "." table)
91 (modify-syntax-entry ?> "." table)
92 (modify-syntax-entry ?\' "\"" table)
93 (setq prolog-mode-syntax-table table)))
95 (define-abbrev-table 'prolog-mode-abbrev-table ())
97 (defun prolog-mode-variables ()
98 (set-syntax-table prolog-mode-syntax-table)
99 (setq local-abbrev-table prolog-mode-abbrev-table)
100 (make-local-variable 'paragraph-start)
101 (setq paragraph-start (concat "%%\\|$\\|" page-delimiter)) ;'%%..'
102 (make-local-variable 'paragraph-separate)
103 (setq paragraph-separate paragraph-start)
104 (make-local-variable 'paragraph-ignore-fill-prefix)
105 (setq paragraph-ignore-fill-prefix t)
106 (make-local-variable 'imenu-generic-expression)
107 (setq imenu-generic-expression "^[a-z][a-zA-Z0-9_]+")
108 (make-local-variable 'indent-line-function)
109 (setq indent-line-function 'prolog-indent-line)
110 (make-local-variable 'comment-start)
111 (setq comment-start "%")
112 (make-local-variable 'comment-start-skip)
113 (setq comment-start-skip "%+ *")
114 (make-local-variable 'comment-column)
115 (setq comment-column 48)
116 (make-local-variable 'comment-indent-function)
117 (setq comment-indent-function 'prolog-comment-indent))
119 (defun prolog-mode-commands (map)
120 (define-key map "\t" 'prolog-indent-line)
121 (define-key map "\e\C-x" 'prolog-consult-region))
125 (setq prolog-mode-map (make-sparse-keymap))
126 (prolog-mode-commands prolog-mode-map))
129 (defun prolog-mode ()
130 "Major mode for editing Prolog code for Prologs.
131 Blank lines and `%%...' separate paragraphs. `%'s start comments.
134 Entry to this mode calls the value of `prolog-mode-hook'
135 if that value is non-nil."
137 (kill-all-local-variables)
138 (use-local-map prolog-mode-map)
139 (setq major-mode 'prolog-mode)
140 (setq mode-name "Prolog")
141 (prolog-mode-variables)
143 (setq font-lock-defaults '(prolog-font-lock-keywords
146 (run-hooks 'prolog-mode-hook))
148 (defun prolog-indent-line (&optional whole-exp)
149 "Indent current line as Prolog code.
150 With argument, indent any additional lines of the same clause
151 rigidly along with this one (not yet)."
153 (let ((indent (prolog-indent-level))
154 (pos (- (point-max) (point))) beg)
157 (skip-chars-forward " \t")
158 (if (zerop (- indent (current-column)))
160 (delete-region beg (point))
162 (if (> (- (point-max) pos) (point))
163 (goto-char (- (point-max) pos)))
166 (defun prolog-indent-level ()
167 "Compute prolog indentation level."
170 (skip-chars-forward " \t")
172 ((looking-at "%%%") 0) ;Large comment starts
173 ((looking-at "%[^%]") comment-column) ;Small comment starts
174 ((bobp) 0) ;Beginning of buffer
176 (let ((empty t) ind more less)
178 (setq less t) ;Find close
180 ;; See previous indentation
186 (skip-chars-forward " \t")
187 (if (not (or (looking-at "%[^%]") (looking-at "\n")))
190 (setq ind 0) ;Beginning of buffer
191 (setq ind (current-column))) ;Beginning of clause
193 (if (looking-at "%%[^%]")
197 (setq more t) ;Find open
200 (end-of-prolog-clause)
201 (or (bobp) (forward-char -1))
202 (cond ((looking-at "[,(;>]")
203 (if (and more (looking-at "[^,]"))
204 (+ ind prolog-indent-width) ;More indentation
205 (max tab-width ind))) ;Same indentation
206 ((looking-at "-") tab-width) ;TAB
207 ((or less (looking-at "[^.]"))
208 (max (- ind prolog-indent-width) 0)) ;Less indentation
209 (t 0)) ;No indentation
213 (defun end-of-prolog-clause ()
214 "Go to end of clause in this line."
215 (beginning-of-line 1)
216 (let* ((eolpos (save-excursion (end-of-line) (point))))
217 (if (re-search-forward comment-start-skip eolpos 'move)
218 (goto-char (match-beginning 0)))
219 (skip-chars-backward " \t")))
221 (defun prolog-comment-indent ()
222 "Compute prolog comment indentation."
223 (cond ((looking-at "%%%") 0)
224 ((looking-at "%%") (prolog-indent-level))
227 (skip-chars-backward " \t")
228 ;; Insert one space at least, except at left margin.
229 (max (+ (current-column) (if (bolp) 0 1))
235 ;;; Inferior prolog mode
237 (defvar inferior-prolog-mode-map nil)
239 (defun inferior-prolog-mode ()
240 "Major mode for interacting with an inferior Prolog process.
242 The following commands are available:
243 \\{inferior-prolog-mode-map}
245 Entry to this mode calls the value of `prolog-mode-hook' with no arguments,
246 if that value is non-nil. Likewise with the value of `comint-mode-hook'.
247 `prolog-mode-hook' is called after `comint-mode-hook'.
249 You can send text to the inferior Prolog from other buffers
250 using the commands `send-region', `send-string' and \\[prolog-consult-region].
253 Tab indents for Prolog; with argument, shifts rest
254 of expression rigidly with the current line.
255 Paragraphs are separated only by blank lines and '%%'.
258 Return at end of buffer sends line as input.
259 Return not at end copies rest of line to end and sends it.
260 \\[comint-kill-input] and \\[backward-kill-word] are kill commands, imitating normal Unix input editing.
261 \\[comint-interrupt-subjob] interrupts the shell or its current subjob if any.
262 \\[comint-stop-subjob] stops. \\[comint-quit-subjob] sends quit signal."
266 (setq major-mode 'inferior-prolog-mode
267 mode-name "Inferior Prolog"
268 comint-prompt-regexp "^| [ ?][- ] *")
269 (prolog-mode-variables)
270 (if inferior-prolog-mode-map nil
271 (setq inferior-prolog-mode-map (copy-keymap comint-mode-map))
272 (prolog-mode-commands inferior-prolog-mode-map))
273 (use-local-map inferior-prolog-mode-map)
274 (run-hooks 'prolog-mode-hook))
278 "Run an inferior Prolog process, input and output via buffer *prolog*."
281 (switch-to-buffer (make-comint "prolog" prolog-program-name))
282 (inferior-prolog-mode))
284 (defun prolog-consult-region (compile beg end)
285 "Send the region to the Prolog process made by \"M-x run-prolog\".
286 If COMPILE (prefix arg) is not nil, use compile mode rather than consult mode."
290 (send-string "prolog" prolog-compile-string)
291 (send-string "prolog" prolog-consult-string))
292 (send-region "prolog" beg end)
293 (send-string "prolog" "\n") ;May be unnecessary
294 (if prolog-eof-string
295 (send-string "prolog" prolog-eof-string)
296 (process-send-eof "prolog")))) ;Send eof to prolog process.
298 (defun prolog-consult-region-and-go (compile beg end)
299 "Send the region to the inferior Prolog, and switch to *prolog* buffer.
300 If COMPILE (prefix arg) is not nil, use compile mode rather than consult mode."
302 (prolog-consult-region compile beg end)
303 (switch-to-buffer "*prolog*"))
307 ;;; prolog.el ends here